category Zend
package Zend_InputFilter

 Methods

Add an input to the input filter

add(\Zend\InputFilter\InputInterface | \Zend\InputFilter\InputFilterInterface | array $input, null | string $name) : \Zend\InputFilter\InputFilterInterface

Parameters

$name

nullstring

Name used to retrieve this input

Returns

Return a list of inputs that were invalid.

getInvalidInput() : \Zend\InputFilter\InputInterface[]

Implementations should return an associative array of name/input pairs that failed validation.

Returns

Return a list of validation failure messages

getMessages() : array

Should return an associative array of named input/message list pairs. Pairs should only be returned for inputs that failed validation.

Returns

array

Retrieve a raw (unfiltered) value from a named input

getRawValue(string $name) : mixed

Parameters

$name

string

Returns

mixed

Return a list of unfiltered values

getRawValues() : array

List should be an associative array of named input/value pairs, with the values unfiltered.

Returns

array

Return a list of inputs that were valid.

getValidInput() : \Zend\InputFilter\InputInterface[]

Implementations should return an associative array of name/input pairs that passed validation.

Returns

Retrieve a value from a named input

getValue(string $name) : mixed

Parameters

$name

string

Returns

mixed

Return a list of filtered values

getValues() : array

List should be an associative array, with the values filtered. If validation failed, this should raise an exception.

Returns

array

Test if an input or input filter by the given name is attached

has(string $name) : bool

Parameters

$name

string

Returns

bool

Is the data set valid?

isValid() : bool

Returns

bool

Remove a named input

remove(string $name) : \Zend\InputFilter\InputFilterInterface

Parameters

$name

string

Returns

Set data to use when validating and filtering

setData(array | \Traversable $data) : \Zend\InputFilter\InputFilterInterface

Parameters

$data

array\Traversable

Returns

Provide a list of one or more elements indicating the complete set to validate

setValidationGroup(mixed $name) : \Zend\InputFilter\InputFilterInterface

When provided, calls to isValid() will only validate the provided set.

If the initial value is VALIDATE_ALL, the current validation group, if any, should be cleared.

Implementations should allow passing a single array value, or multiple arguments, each specifying a single input.

Parameters

$name

mixed

Returns

 Constants

 

VALIDATE_ALL

VALIDATE_ALL