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

Public Member Functions

 __construct ($name=null)
 
 setAllowEmpty ($allowEmpty)
 
 setBreakOnFailure ($breakOnFailure)
 
 setContinueIfEmpty ($continueIfEmpty)
 
 setErrorMessage ($errorMessage)
 
 setFilterChain (FilterChain $filterChain)
 
 setName ($name)
 
 setRequired ($required)
 
 setValidatorChain (ValidatorChain $validatorChain)
 
 setValue ($value)
 Set the input value.
 
 resetValue ()
 Reset input value to the default state.
 
 setFallbackValue ($value)
 
 allowEmpty ()
 
 breakOnFailure ()
 
 continueIfEmpty ()
 
 getErrorMessage ()
 
 getFilterChain ()
 
 getName ()
 
 getRawValue ()
 
 isRequired ()
 
 getValidatorChain ()
 
 getValue ()
 
 hasValue ()
 Flag for inform if input value was set.
 
 getFallbackValue ()
 
 hasFallback ()
 
 clearFallbackValue ()
 
 merge (InputInterface $input)
 
 isValid ($context=null)
 
 getMessages ()
 
- Public Member Functions inherited from InputInterface
 isValid ()
 

Protected Member Functions

 injectNotEmptyValidator ()
 
 prepareRequiredValidationFailureMessage ()
 Create and return the validation failure message for required input.
 

Protected Attributes

 $allowEmpty = false
 
 $continueIfEmpty = false
 
 $breakOnFailure = false
 
 $errorMessage
 
 $filterChain
 
 $name
 
 $notEmptyValidator = false
 
 $required = true
 
 $validatorChain
 
 $value
 
 $hasValue = false
 
 $fallbackValue
 
 $hasFallback = false
 

Constructor & Destructor Documentation

__construct (   $name = null)

Member Function Documentation

allowEmpty ( )
Deprecated:
2.4.8 Add Zend validator to the ValidatorChain.
Returns
bool

Implements InputInterface.

breakOnFailure ( )
Returns
bool

Implements InputInterface.

clearFallbackValue ( )
continueIfEmpty ( )
Deprecated:
2.4.8 Add Zend validator to the ValidatorChain. Should always return `true`.
Returns
bool

Implements EmptyContextInterface.

getErrorMessage ( )
Returns
string|null

Implements InputInterface.

getFallbackValue ( )
Returns
mixed
getFilterChain ( )
Returns
FilterChain

Implements InputInterface.

getMessages ( )
Returns
string[]

Implements InputInterface.

getName ( )
Returns
string

Implements InputInterface.

getRawValue ( )
Returns
mixed

Implements InputInterface.

getValidatorChain ( )
Returns
ValidatorChain

Implements InputInterface.

getValue ( )
Returns
mixed

Implements InputInterface.

hasFallback ( )
Returns
bool
hasValue ( )

Flag for inform if input value was set.

This flag used for distinguish when Input::getValue() will return the value previously set or the default.

See Also
Input::getValue() For retrieve the input value.
Input::setValue() For set a new value.
Input::resetValue() For reset the input value to the default state.
Returns
bool
injectNotEmptyValidator ( )
protected
Deprecated:
2.4.8 Add Zend validator to the ValidatorChain.
Returns
void
isRequired ( )
Returns
bool

Implements InputInterface.

isValid (   $context = null)
Parameters
mixed$contextExtra "context" to provide the validator
Returns
bool
merge ( InputInterface  $input)
Parameters
InputInterface$input
Returns
Input

Implements InputInterface.

prepareRequiredValidationFailureMessage ( )
protected

Create and return the validation failure message for required input.

Returns
string[]
resetValue ( )

Reset input value to the default state.

See Also
Input::hasValue() For to know if input value was set.
Input::setValue() For set a new value.
Returns
Input
setAllowEmpty (   $allowEmpty)
Deprecated:
2.4.8 Add Zend validator to the ValidatorChain and set this to `true`.
Parameters
bool$allowEmpty
Returns
Input

Implements InputInterface.

setBreakOnFailure (   $breakOnFailure)
Parameters
bool$breakOnFailure
Returns
Input

Implements InputInterface.

setContinueIfEmpty (   $continueIfEmpty)
Deprecated:
2.4.8 Add Zend validator to the ValidatorChain and set this to `true`.
Parameters
bool$continueIfEmpty
Returns
Input

Implements EmptyContextInterface.

setErrorMessage (   $errorMessage)
Parameters
string | null$errorMessage
Returns
Input

Implements InputInterface.

setFallbackValue (   $value)
Parameters
mixed$value
Returns
Input
setFilterChain ( FilterChain  $filterChain)
Parameters
FilterChain$filterChain
Returns
Input

Implements InputInterface.

setName (   $name)
Parameters
string$name
Returns
Input

Implements InputInterface.

setRequired (   $required)
Parameters
bool$required
Returns
Input

Implements InputInterface.

setValidatorChain ( ValidatorChain  $validatorChain)
Parameters
ValidatorChain$validatorChain
Returns
Input

Implements InputInterface.

setValue (   $value)

Set the input value.

If you want to remove/unset the current value use Input::resetValue().

See Also
Input::getValue() For retrieve the input value.
Input::hasValue() For to know if input value was set.
Input::resetValue() For reset the input value to the default state.
Parameters
mixed$value
Returns
Input

Implements InputInterface.

Member Data Documentation

$allowEmpty = false
protected
$breakOnFailure = false
protected
$continueIfEmpty = false
protected
$errorMessage
protected
$fallbackValue
protected
$filterChain
protected
$hasFallback = false
protected
$hasValue = false
protected
$name
protected
$notEmptyValidator = false
protected
$required = true
protected
$validatorChain
protected
$value
protected