Summary

Fully Qualified Name:	Laminas\InputFilter\Input
Implements:	InputInterface, EmptyContextInterface

Description

Methods

Name	Description	Defined By
__construct()		Input
allowEmpty()		Input
breakOnFailure()		Input
clearFallbackValue()		Input
continueIfEmpty()		Input
getErrorMessage()		Input
getFallbackValue()		Input
getFilterChain()		Input
getMessages()		Input
getName()		Input
getRawValue()		Input
getValidatorChain()		Input
getValue()		Input
hasFallback()		Input
hasValue()	Flag for inform if input value was set.	Input
isRequired()		Input
isValid()		Input
merge()		Input
resetValue()	Reset input value to the default state.	Input
setAllowEmpty()		Input
setBreakOnFailure()		Input
setContinueIfEmpty()		Input
setErrorMessage()		Input
setFallbackValue()		Input
setFilterChain()		Input
setName()		Input
setRequired()		Input
setValidatorChain()		Input
setValue()	Set the input value.	Input

Method Details

__construct()

Parameter Name	Type	Description
$name

Returns: void

allowEmpty()

Returns: bool

breakOnFailure()

Returns: bool

clearFallbackValue()

Returns: void

continueIfEmpty()

Returns: bool

getErrorMessage()

Returns: string|null

getFallbackValue()

Returns: mixed

getFilterChain()

Returns: \FilterChain

getMessages()

Returns: string[]

getName()

Returns: string

getRawValue()

Returns: mixed

getValidatorChain()

Returns: \ValidatorChain

getValue()

Returns: mixed

hasFallback()

Returns: bool

hasValue()

Flag for inform if input value was set.

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

Returns: bool

isRequired()

Returns: bool

isValid()

Parameter Name	Type	Description
$context	mixed	Extra

Returns: bool

merge()

Parameter Name	Type	Description
$input	\InputInterface

Returns: \Input

resetValue()

Reset input value to the default state.

Returns: \Input

setAllowEmpty()

Parameter Name	Type	Description
$allowEmpty	bool

Returns: \Input

setBreakOnFailure()

Parameter Name	Type	Description
$breakOnFailure	bool

Returns: \Input

setContinueIfEmpty()

Parameter Name	Type	Description
$continueIfEmpty	bool

Returns: \Input

setErrorMessage()

Parameter Name	Type	Description
$errorMessage	string|null

Returns: \Input

setFallbackValue()

Parameter Name	Type	Description
$value	mixed

Returns: \Input

setFilterChain()

Parameter Name	Type	Description
$filterChain	\FilterChain

Returns: \Input

setName()

Parameter Name	Type	Description
$name	string

Returns: \Input

setRequired()

Parameter Name	Type	Description
$required	bool

Returns: \Input

setValidatorChain()

Parameter Name	Type	Description
$validatorChain	\ValidatorChain

Returns: \Input

setValue()

Set the input value.

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

Parameter Name	Type	Description
$value	mixed

Returns: \Input