Zend Framework  2.4
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
NotEmpty Class Reference

Public Member Functions

 __construct ($options=null)
 Constructor.
 
 getType ()
 Returns the set types.
 
 getDefaultType ()
 
 setType ($type=null)
 Set the types.
 
 isValid ($value)
 Returns true if and only if $value is not an empty 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=array())
 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 BOOLEAN = 0x001
 
const INTEGER = 0x002
 
const FLOAT = 0x004
 
const STRING = 0x008
 
const ZERO = 0x010
 
const EMPTY_ARRAY = 0x020
 
const NULL = 0x040
 
const PHP = 0x07F
 
const SPACE = 0x080
 
const OBJECT = 0x100
 
const OBJECT_STRING = 0x200
 
const OBJECT_COUNT = 0x400
 
const ALL = 0x7FF
 
const INVALID = 'notEmptyInvalid'
 
const IS_EMPTY = 'isEmpty'
 

Protected Member Functions

 calculateTypeValue ($type)
 
- 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.
 

Protected Attributes

 $constants
 
 $defaultType
 
 $messageTemplates
 
 $options = array()
 
- 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.
 
- Static Protected Attributes inherited from AbstractValidator
static $defaultTranslator
 
static $defaultTranslatorTextDomain = 'default'
 
static $messageLength = -1
 

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor.

Parameters
array | Traversable | int$optionsOPTIONAL

Member Function Documentation

calculateTypeValue (   $type)
protected
Parameters
array | int | string$type
Returns
int
getDefaultType ( )
Returns
int
getType ( )

Returns the set types.

Returns
array
isValid (   $value)

Returns true if and only if $value is not an empty value.

Parameters
string$value
Returns
bool

Implements ValidatorInterface.

setType (   $type = null)

Set the types.

Parameters
int | array$type
Exceptions
Exception\InvalidArgumentException
Returns
NotEmpty

Member Data Documentation

$constants
protected
Initial value:
= array(
self::BOOLEAN => 'boolean',
self::INTEGER => 'integer',
self::FLOAT => 'float',
self::STRING => 'string',
self::ZERO => 'zero',
self::EMPTY_ARRAY => 'array',
self::NULL => 'null',
self::PHP => 'php',
self::SPACE => 'space',
self::OBJECT => 'object',
self::OBJECT_STRING => 'objectstring',
self::OBJECT_COUNT => 'objectcount',
self::ALL => 'all',
)
$defaultType
protected
Initial value:
= array(
self::OBJECT,
self::SPACE,
self::NULL,
self::EMPTY_ARRAY,
self::STRING,
self::FLOAT,
self::BOOLEAN
)
$messageTemplates
protected
Initial value:
= array(
self::IS_EMPTY => "Value is required and can't be empty",
self::INVALID => "Invalid type given. String, integer, float, boolean or array expected",
)
$options = array()
protected
const ALL = 0x7FF
const BOOLEAN = 0x001
const EMPTY_ARRAY = 0x020
const FLOAT = 0x004
const INTEGER = 0x002
const INVALID = 'notEmptyInvalid'
const IS_EMPTY = 'isEmpty'
const NULL = 0x040
const OBJECT = 0x100
const OBJECT_COUNT = 0x400
const OBJECT_STRING = 0x200
const PHP = 0x07F
const SPACE = 0x080
const STRING = 0x008
const ZERO = 0x010