package Default
inherited_from \Zend\InputFilter\Input

 Methods

__construct()

__construct($name = null
Inherited

Parameters

$name

allowEmpty()

allowEmpty() : boolean
Inherited
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain.
inherited_from \Zend\InputFilter\InputInterface::allowEmpty()

Returns

boolean

breakOnFailure()

breakOnFailure() : boolean
Inherited
inherited_from \Zend\InputFilter\InputInterface::breakOnFailure()

Returns

boolean

clearFallbackValue()

clearFallbackValue() 
Inherited

continueIfEmpty()

continueIfEmpty() : boolean
Inherited
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain. Should always return `true`.
inherited_from \Zend\InputFilter\EmptyContextInterface::continueIfEmpty()

Returns

boolean

getErrorMessage()

getErrorMessage() : string | null
Inherited
inherited_from \Zend\InputFilter\InputInterface::getErrorMessage()

Returns

stringnull

getFallbackValue()

getFallbackValue() : mixed
Inherited

Returns

mixed

getFilterChain()

getFilterChain() : \Zend\Filter\FilterChain
Inherited
inherited_from \Zend\InputFilter\InputInterface::getFilterChain()

Returns

\Zend\Filter\FilterChain

getMessages()

getMessages() : array<mixed,string>
Inherited
inherited_from \Zend\InputFilter\InputInterface::getMessages()

Returns

array<mixed,string>

getName()

getName() : string
Inherited
inherited_from \Zend\InputFilter\InputInterface::getName()

Returns

string

getRawValue()

getRawValue() : mixed
Inherited
inherited_from \Zend\InputFilter\InputInterface::getRawValue()

Returns

mixed

getValidatorChain()

getValidatorChain() : \Zend\Validator\ValidatorChain
Inherited
inherited_from \Zend\InputFilter\InputInterface::getValidatorChain()

Returns

\Zend\Validator\ValidatorChain

getValue()

getValue() : array
inherited_from \Zend\InputFilter\Input::getValue()

Returns

array

getValue()

getValue() : mixed
Inherited
inherited_from \Zend\InputFilter\InputInterface::getValue()

Returns

mixed

hasFallback()

hasFallback() : boolean
Inherited

Returns

boolean

Flag for inform if input value was set.

hasValue() : boolean
Inherited

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

see For retrieve the input value.
see For set a new value.
see For reset the input value to the default state.

Returns

boolean

isRequired()

isRequired() : boolean
Inherited
inherited_from \Zend\InputFilter\InputInterface::isRequired()

Returns

boolean

isValid()

isValid(mixed $context = null) : boolean
inherited_from \Zend\InputFilter\Input::isValid()

Parameters

$context

mixed

Extra "context" to provide the validator

Returns

boolean

isValid()

isValid(mixed $context = null) : boolean
Inherited
inherited_from \Zend\InputFilter\InputInterface::isValid()

Parameters

$context

mixed

Extra "context" to provide the validator

Returns

boolean

merge()

merge(\Zend\InputFilter\InputInterface $input) : \Zend\InputFilter\Input
Inherited
inherited_from \Zend\InputFilter\InputInterface::merge()

Parameters

$input

\Zend\InputFilter\InputInterface

Returns

\Zend\InputFilter\Input

Reset input value to the default state.

resetValue() 
inherited_from \Zend\InputFilter\Input::resetValue()

Reset input value to the default state.

resetValue() : \Zend\InputFilter\Input
Inherited
see For to know if input value was set.
see For set a new value.

Returns

\Zend\InputFilter\Input

setAllowEmpty()

setAllowEmpty(boolean $allowEmpty) : \Zend\InputFilter\Input
Inherited
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain and set this to `true`.
inherited_from \Zend\InputFilter\InputInterface::setAllowEmpty()

Parameters

$allowEmpty

boolean

Returns

\Zend\InputFilter\Input

setBreakOnFailure()

setBreakOnFailure(boolean $breakOnFailure) : \Zend\InputFilter\Input
Inherited
inherited_from \Zend\InputFilter\InputInterface::setBreakOnFailure()

Parameters

$breakOnFailure

boolean

Returns

\Zend\InputFilter\Input

setContinueIfEmpty()

setContinueIfEmpty(boolean $continueIfEmpty) : \Zend\InputFilter\Input
Inherited
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain and set this to `true`.
inherited_from \Zend\InputFilter\EmptyContextInterface::setContinueIfEmpty()

Parameters

$continueIfEmpty

boolean

Returns

\Zend\InputFilter\Input

setErrorMessage()

setErrorMessage(string|null $errorMessage) : \Zend\InputFilter\Input
Inherited
inherited_from \Zend\InputFilter\InputInterface::setErrorMessage()

Parameters

$errorMessage

stringnull

Returns

\Zend\InputFilter\Input

setFallbackValue()

setFallbackValue(mixed $value) : \Zend\InputFilter\Input
Inherited

Parameters

$value

mixed

Returns

\Zend\InputFilter\Input

setFilterChain()

setFilterChain(\Zend\Filter\FilterChain $filterChain) : \Zend\InputFilter\Input
Inherited
inherited_from \Zend\InputFilter\InputInterface::setFilterChain()

Parameters

$filterChain

\Zend\Filter\FilterChain

Returns

\Zend\InputFilter\Input

setName()

setName(string $name) : \Zend\InputFilter\Input
Inherited
inherited_from \Zend\InputFilter\InputInterface::setName()

Parameters

$name

string

Returns

\Zend\InputFilter\Input

setRequired()

setRequired(boolean $required) : \Zend\InputFilter\Input
Inherited
inherited_from \Zend\InputFilter\InputInterface::setRequired()

Parameters

$required

boolean

Returns

\Zend\InputFilter\Input

setValidatorChain()

setValidatorChain(\Zend\Validator\ValidatorChain $validatorChain) : \Zend\InputFilter\Input
Inherited
inherited_from \Zend\InputFilter\InputInterface::setValidatorChain()

Parameters

$validatorChain

\Zend\Validator\ValidatorChain

Returns

\Zend\InputFilter\Input

Set the input value.

setValue(array $value) : \Zend\InputFilter\Input

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

inherited_from \Zend\InputFilter\Input::setValue()

Parameters

$value

array

Exceptions

\Zend\InputFilter\Exception\InvalidArgumentException

Returns

\Zend\InputFilter\Input

Set the input value.

setValue(mixed $value) : \Zend\InputFilter\Input
Inherited

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

see For retrieve the input value.
see For to know if input value was set.
see For reset the input value to the default state.
inherited_from \Zend\InputFilter\InputInterface::setValue()

Parameters

$value

mixed

Returns

\Zend\InputFilter\Input

injectNotEmptyValidator()

injectNotEmptyValidator() : void
Inherited
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain.

Create and return the validation failure message for required input.

prepareRequiredValidationFailureMessage() : array<mixed,string>
Inherited

Returns

array<mixed,string>

 Properties

 

$allowEmpty

$allowEmpty : boolean

Default

false
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain.
 

$breakOnFailure

$breakOnFailure : boolean

Default

false
 

$continueIfEmpty

$continueIfEmpty : boolean

Default

false
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain.
 

$errorMessage

$errorMessage : string | null

Default

 

$fallbackValue

$fallbackValue : mixed

Default

 

$filterChain

$filterChain : \Zend\Filter\FilterChain

Default

 

$hasFallback

$hasFallback : boolean

Default

false
 

Flag for distinguish when $value contains the value previously set or the default one.

$hasValue : boolean

Default

false
 

$name

$name : string

Default

 

$notEmptyValidator

$notEmptyValidator : boolean

Default

false
deprecated 2.4.8 Add Zend\Validator\NotEmpty validator to the ValidatorChain.
 

$required

$required : boolean

Default

true
 

$validatorChain

$validatorChain : \Zend\Validator\ValidatorChain

Default

 

$value

$value : array

Default

array()
inherited_from \Zend\InputFilter\Input::value
 

$value

$value : mixed

Default