Zend Framework  3.0
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Explode Class Reference

Public Member Functions

 setValueDelimiter ($delimiter)
 Sets the delimiter string that the values will be split upon.
 
 getValueDelimiter ()
 Returns the delimiter string that the values will be split upon.
 
 setValidatorPluginManager (ValidatorPluginManager $pluginManager)
 Set validator plugin manager.
 
 getValidatorPluginManager ()
 Get validator plugin manager.
 
 setValidator ($validator)
 Sets the Validator for validating each value.
 
 getValidator ()
 Gets the Validator for validating each value.
 
 setBreakOnFirstFailure ($break)
 Set break on first failure setting.
 
 isBreakOnFirstFailure ()
 Get break on first failure setting.
 
 isValid ($value, $context=null)
 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 Member Functions inherited from ValidatorInterface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Public Attributes

const INVALID = 'explodeInvalid'
 

Protected Attributes

 $pluginManager
 
 $messageTemplates
 
 $messageVariables = []
 
 $valueDelimiter = ','
 
 $validator
 
 $breakOnFirstFailure = false
 
- 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
 

Member Function Documentation

getValidator ( )

Gets the Validator for validating each value.

Returns
ValidatorInterface
getValidatorPluginManager ( )

Get validator plugin manager.

Returns
ValidatorPluginManager

Implements ValidatorPluginManagerAwareInterface.

getValueDelimiter ( )

Returns the delimiter string that the values will be split upon.

Returns
string
isBreakOnFirstFailure ( )

Get break on first failure setting.

Returns
bool
isValid (   $value,
  $context = null 
)

Defined by Zend.

Returns true if all values validate true

Parameters
mixed$value
mixed$contextExtra "context" to provide the composed validator
Returns
bool
Exceptions
Exception\RuntimeException
setBreakOnFirstFailure (   $break)

Set break on first failure setting.

Parameters
bool$break
Returns
Explode
setValidator (   $validator)

Sets the Validator for validating each value.

Parameters
ValidatorInterface | array$validator
Exceptions
Exception\RuntimeException
Returns
Explode
setValidatorPluginManager ( ValidatorPluginManager  $pluginManager)

Set validator plugin manager.

Parameters
ValidatorPluginManager$pluginManager

Implements ValidatorPluginManagerAwareInterface.

setValueDelimiter (   $delimiter)

Sets the delimiter string that the values will be split upon.

Parameters
string$delimiter
Returns
Explode

Member Data Documentation

$breakOnFirstFailure = false
protected
$messageTemplates
protected
Initial value:
= [
self::INVALID => "Invalid type given"
$messageVariables = []
protected
$pluginManager
protected
$validator
protected
$valueDelimiter = ','
protected
const INVALID = 'explodeInvalid'