Zend_Validate_Barcode Class Reference

Public Member Functions
	__construct ($adapter)
	Generates the standard validator object.
	getAdapter ()
	Returns the set adapter.
	setAdapter ($adapter, $options=null)
	Sets a new barcode adapter.
	getChecksum ()
	Returns the checksum option.
	setChecksum ($checksum)
	Sets the checksum option.
	isValid ($value)
	Defined by Zend_Validate_Interface.
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	INVALID = 'barcodeInvalid'
const	FAILED = 'barcodeFailed'
const	INVALID_CHARS = 'barcodeInvalidChars'
const	INVALID_LENGTH = 'barcodeInvalidLength'

Protected Attributes
	$_messageTemplates
	$_messageVariables
	$_length
	$_adapter
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.
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.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__construct

(

$adapter

)

Generates the standard validator object.

Parameters

string|Zend_Config|

Zend_Validate_Barcode_BarcodeAdapter $adapter Barcode adapter to use

Returns

void

Exceptions

Zend_Validate_Exception

Member Function Documentation

getAdapter

(

)

Returns the set adapter.

Returns

Zend_Validate_Barcode_BarcodeAdapter

getChecksum

(

)

Returns the checksum option.

Returns

boolean

isValid

(

$value

)

Defined by Zend_Validate_Interface.

Returns true if and only if $value contains a valid barcode

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

setAdapter	(		$adapter,
			$options = null
	)

Sets a new barcode adapter.

Parameters

string | Zend_Validate_Barcode	$adapter	Barcode adapter to use
array	$options	Options for this adapter

Returns

void

Exceptions

Zend_Validate_Exception

setChecksum

(

$checksum

)

Sets the checksum option.

Parameters

boolean

$checksum

Returns

Zend_Validate_Barcode

Member Data Documentation

$_adapter

protected

$_length

protected

$_messageTemplates

protected

Initial value:

= array(
        self::FAILED         => "'%value%' failed checksum validation",
        self::INVALID_CHARS  => "'%value%' contains invalid characters",
        self::INVALID_LENGTH => "'%value%' should have a length of %length% characters",
        self::INVALID        => "Invalid type given. String expected",
    )

$_messageVariables

protected

Initial value:

= array(
        'length' => '_length'
    )

const FAILED = 'barcodeFailed'

const INVALID = 'barcodeInvalid'

const INVALID_CHARS = 'barcodeInvalidChars'

const INVALID_LENGTH = 'barcodeInvalidLength'