Callback Class Reference

Public Member Functions
	__construct ($options=null)
	Constructor.
	getCallback ()
	Returns the set callback.
	setCallback ($callback)
	Sets the callback.
	getCallbackOptions ()
	Returns the set options for the callback.
	setCallbackOptions ($options)
	Sets options for the callback.
	isValid ($value, $context=null)
	Returns true if and only if the set callback returns for the provided $value.
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 Member Functions inherited from ValidatorInterface
	isValid ($value)
	Returns true if and only if $value meets the validation requirements.

Public Attributes
const	INVALID_CALLBACK = 'callbackInvalid'
	Invalid callback.
const	INVALID_VALUE = 'callbackValue'
	Invalid value.

Protected Attributes
	$messageTemplates
	$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.

Parameters

array | callable

$options

Member Function Documentation

getCallback

(

)

Returns the set callback.

Returns

mixed

getCallbackOptions

(

)

Returns the set options for the callback.

Returns

mixed

isValid	(		$value,
			$context = null
	)

Returns true if and only if the set callback returns for the provided $value.

Parameters

mixed	$value
mixed	$context	Additional context to provide to the callback

Returns

bool

Exceptions

Exception\InvalidArgumentException

setCallback

(

$callback

)

Sets the callback.

Parameters

string | array | callable

$callback

Returns

Callback Provides a fluent interface

Exceptions

Exception\InvalidArgumentException

setCallbackOptions

(

$options

)

Sets options for the callback.

Parameters

mixed

$options

Returns

Callback Provides a fluent interface

Member Data Documentation

$messageTemplates

protected

Initial value:

= [
        self::INVALID_VALUE    => "The input is not valid"

$options

protected

Initial value:

= [
        'callback'         => null

const INVALID_CALLBACK = 'callbackInvalid'

Invalid callback.

const INVALID_VALUE = 'callbackValue'

Invalid value.