Barcode Class Reference

Public Member Functions
	__construct ($options=null)
	Constructor for barcodes.
	getAdapter ()
	Returns the set adapter.
	setAdapter ($adapter, $options=null)
	Sets a new barcode adapter.
	getChecksum ()
	Returns the checksum option.
	useChecksum ($checksum=null)
	Sets if checksum should be validated, if no value is given the actual setting is returned.
	isValid ($value)
	Defined by Zend.
Public Member Functions inherited from AbstractValidator
	__construct ($options=null)
	Abstract constructor for all validators A validator should accept following parameters:
	getOption ($option)
	Returns an option.
	getOptions ()
	Returns all available options.
	setOptions ($options=[])
	Sets one or multiple options.
	getMessages ()
	Returns array of validation failure messages.
	__invoke ($value)
	Invoke as command.
	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.
	setValueObscured ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	isValueObscured ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setTranslatorTextDomain ($textDomain= 'default')
	Set translation text domain.
	getTranslatorTextDomain ()
	Return the translation text domain.
	setTranslatorEnabled ($flag=true)
	Indicate whether or not translation should be enabled.
	isTranslatorEnabled ()
	Is translation enabled?
Public Member Functions inherited from TranslatorAwareInterface
	setTranslator (TranslatorInterface $translator=null, $textDomain=null)
	Sets translator to use in helper.

Public Attributes
const	INVALID = 'barcodeInvalid'
const	FAILED = 'barcodeFailed'
const	INVALID_CHARS = 'barcodeInvalidChars'
const	INVALID_LENGTH = 'barcodeInvalidLength'

Protected Attributes
	$messageTemplates
	$messageVariables
	$options
Protected Attributes inherited from AbstractValidator
	$value
	$abstractOptions

Additional Inherited Members
Static Public Member Functions inherited from AbstractValidator
static	setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=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	setDefaultTranslatorTextDomain ($textDomain= 'default')
	Set default translation text domain for all validate objects.
static	getDefaultTranslatorTextDomain ()
	Get default translation text domain for all validate objects.
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Protected Member Functions inherited from AbstractValidator
	createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	error ($messageKey, $value=null)
	getValue ()
	Returns the validation value.
	setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
	translateMessage ($messageKey, $message)
	Translate a validation message.
Static Protected Attributes inherited from AbstractValidator
static	$defaultTranslator
static	$defaultTranslatorTextDomain = 'default'
static	$messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options = null

)

Constructor for barcodes.

Parameters

array | string

$options

Options to use

Member Function Documentation

getAdapter

(

)

Returns the set adapter.

Returns

Barcode

getChecksum

(

)

Returns the checksum option.

Returns

string

isValid

(

$value

)

Defined by Zend.

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

Parameters

string

$value

Returns

bool

Implements ValidatorInterface.

setAdapter	(		$adapter,
			$options = null
	)

Sets a new barcode adapter.

Parameters

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

Returns

Barcode

Exceptions

Exception\InvalidArgumentException

useChecksum

(

$checksum = null

)

Sets if checksum should be validated, if no value is given the actual setting is returned.

Parameters

bool

$checksum

Returns

bool

Member Data Documentation

$messageTemplates

protected

Initial value:

= [
        self::FAILED         => "The input failed checksum validation"

$messageVariables

protected

Initial value:

= [
        'length' => ['options' => 'length'],
    ]

$options

protected

Initial value:

= [
        'adapter'     => null

const FAILED = 'barcodeFailed'

const INVALID = 'barcodeInvalid'

const INVALID_CHARS = 'barcodeInvalidChars'

const INVALID_LENGTH = 'barcodeInvalidLength'