Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Zend_Validate_Isbn Class Reference

Public Member Functions

 __construct ($options=array())
 Set up options.
 
 isValid ($value)
 Defined by Zend_Validate_Interface.
 
 setSeparator ($separator)
 Set separator characters.
 
 getSeparator ()
 Get separator characters.
 
 setType ($type)
 Set allowed ISBN type.
 
 getType ()
 Get allowed ISBN type.
 
- Public Member Functions inherited from Zend_Validate_Abstract
 getMessages ()
 Returns array of validation failure messages.
 
 getMessageVariables ()
 Returns an array of the names of variables that are used in constructing validation failure messages.
 
 getMessageTemplates ()
 Returns the message templates from the validator.
 
 setMessage ($messageString, $messageKey=null)
 Sets the validation failure message template for a particular key.
 
 setMessages (array $messages)
 Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
 
 __get ($property)
 Magic function returns the value of the requested property, if and only if it is the value or a message variable.
 
 getErrors ()
 Returns array of validation failure message codes.
 
 setObscureValue ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 getObscureValue ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator ($translator=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 

Public Attributes

const AUTO = 'auto'
 
const ISBN10 = '10'
 
const ISBN13 = '13'
 
const INVALID = 'isbnInvalid'
 
const NO_ISBN = 'isbnNoIsbn'
 

Protected Member Functions

 _detectFormat ()
 Detect input format.
 
- Protected Member Functions inherited from Zend_Validate_Abstract
 _createMessage ($messageKey, $value)
 Constructs and returns a validation failure message with the given message key and value.
 
 _error ($messageKey, $value=null)
 
 _setValue ($value)
 Sets the value to be validated and clears the messages and errors arrays.
 

Protected Attributes

 $_messageTemplates
 
 $_type = self::AUTO
 
 $_separator = ''
 
- Protected Attributes inherited from Zend_Validate_Abstract
 $_value
 
 $_messageVariables = array()
 
 $_messageTemplates = array()
 
 $_messages = array()
 
 $_obscureValue = false
 
 $_errors = array()
 
 $_translator
 
 $_translatorDisabled = false
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Validate_Abstract
static setDefaultTranslator ($translator=null)
 Set default translation object for all validate objects.
 
static getDefaultTranslator ()
 Get default translation object for all validate objects.
 
static hasDefaultTranslator ()
 Is there a default translation object set?
 
static getMessageLength ()
 Returns the maximum allowed message length.
 
static setMessageLength ($length=-1)
 Sets the maximum allowed message length.
 
- Static Protected Attributes inherited from Zend_Validate_Abstract
static $_defaultTranslator
 
static $_messageLength = -1
 

Constructor & Destructor Documentation

__construct (   $options = array())

Set up options.

Parameters
Zend_Config | array$options
Exceptions
Zend_Validate_ExceptionWhen $options is not valid
Returns
void
See Also
Zend_Validate_Exception

Member Function Documentation

_detectFormat ( )
protected

Detect input format.

Returns
string
getSeparator ( )

Get separator characters.

Returns
string
getType ( )

Get allowed ISBN type.

Returns
string
isValid (   $value)

Defined by Zend_Validate_Interface.

Returns true if and only if $value is a valid ISBN.

Parameters
string$value
Returns
boolean

Implements Zend_Validate_Interface.

setSeparator (   $separator)

Set separator characters.

It is allowed only empty string, hyphen and space.

Parameters
string$separator
Exceptions
Zend_Validate_ExceptionWhen $separator is not valid
Returns
Zend_Validate_Isbn Provides a fluent interface
See Also
Zend_Validate_Exception
setType (   $type)

Set allowed ISBN type.

Parameters
string$type
Exceptions
Zend_Validate_ExceptionWhen $type is not valid
Returns
Zend_Validate_Isbn Provides a fluent interface
See Also
Zend_Validate_Exception

Member Data Documentation

$_messageTemplates
protected
Initial value:
= array(
self::INVALID => "Invalid type given. String or integer expected",
self::NO_ISBN => "'%value%' is not a valid ISBN number",
)
$_separator = ''
protected
$_type = self::AUTO
protected
const AUTO = 'auto'
const INVALID = 'isbnInvalid'
const ISBN10 = '10'
const ISBN13 = '13'
const NO_ISBN = 'isbnNoIsbn'