Methods
Countable: number of inputs in this input filter
count() : int
Inherited
Only details the number of direct children.
| inherited_from |
\Zend\InputFilter\BaseInputFilter::count() |
Returns
int
Get factory to use when adding inputs and filters by spec
getFactory() : \Zend\InputFilter\Factory
Lazy-loads a Factory instance if none attached.
Returns
Return a list of validation failure messages
getMessages() : array
Inherited
Should return an associative array of named input/message list pairs.
Pairs should only be returned for inputs that failed validation.
| inherited_from |
\Zend\InputFilter\BaseInputFilter::getMessages() |
Returns
array
Retrieve a raw (unfiltered) value from a named input
getRawValue(string $name) : mixed
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::getRawValue() |
Parameters
$name
string
Exceptions
Returns
mixed
Return a list of unfiltered values
getRawValues() : array
Inherited
List should be an associative array of named input/value pairs,
with the values unfiltered.
| inherited_from |
\Zend\InputFilter\BaseInputFilter::getRawValues() |
Returns
array
Return the unknown input
getUnknown() : array
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::getUnknown() |
Exceptions
Returns
array
Retrieve a value from a named input
getValue(string $name) : mixed
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::getValue() |
Parameters
$name
string
Exceptions
Returns
mixed
Return a list of filtered values
getValues() : array
Inherited
List should be an associative array, with the values filtered. If
validation failed, this should raise an exception.
| inherited_from |
\Zend\InputFilter\BaseInputFilter::getValues() |
Returns
array
Test if an input or input filter by the given name is attached
has(string $name) : bool
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::has() |
Parameters
$name
string
Returns
bool
Is the data set has unknown input ?
hasUnknown() : bool
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::hasUnknown() |
Exceptions
Returns
bool
This function is automatically called when creating element with factory.
init() : void
Inherited
It
allows to perform various operations (add elements...)
| inherited_from |
\Zend\InputFilter\BaseInputFilter::init() |
Is the data set valid?
isValid(mixed | null $context) : bool
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::isValid() |
Parameters
$context
mixednull
Exceptions
Returns
bool
Merges the inputs from an InputFilter into the current one
merge(\Zend\InputFilter\BaseInputFilter $inputFilter) : \Zend\InputFilter\self
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::merge() |
Parameters
Returns
\Zend\InputFilter\self
Set data to use when validating and filtering
setData(array | \Traversable $data) : \Zend\InputFilter\InputFilterInterface
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::setData() |
Parameters
$data
array\Traversable
Exceptions
Returns
Provide a list of one or more elements indicating the complete set to validate
setValidationGroup(mixed $name) : \Zend\InputFilter\InputFilterInterface
Inherited
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.
| inherited_from |
\Zend\InputFilter\BaseInputFilter::setValidationGroup() |
Parameters
$name
mixed
Exceptions
Returns
Populate the values of all attached inputs
populate() : void
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::populate() |
Ensure all names of a validation group exist as input in the filter
validateValidationGroup(array $inputs) : void
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::validateValidationGroup() |
Parameters
$inputs
array
Exceptions
Properties
$data
$data : array
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::$$data |
$validationGroup
$validationGroup : array
Inherited
| inherited_from |
\Zend\InputFilter\BaseInputFilter::$$validationGroup |
Constants
VALIDATE_ALL
VALIDATE_ALL
Inherited
| inherited_from |
\Zend\InputFilter\InputFilterInterface::VALIDATE_ALL |
| inherited_from |
\Zend\InputFilter\BaseInputFilter::VALIDATE_ALL |