Zend\InputFilter\CollectionInputFilter
Synopsis
class CollectionInputFilter
extends InputFilter
{
- // members
- protected $collectionData;
- protected $collectionValidInputs;
- protected $collectionInvalidInputs;
- protected $isRequired;
- protected $count;
- protected array $collectionValues;
- protected array $collectionRawValues;
- protected array $collectionMessages;
- protected BaseInputFilter $inputFilter;
- // Inherited members from InputFilter
- protected Factory $factory;
- // Inherited members from BaseInputFilter
- protected $data;
- protected array $inputs;
- protected $invalidInputs;
- protected $validationGroup;
- protected $validInputs;
- // methods
- public CollectionInputFilter setInputFilter()
- public BaseInputFilter getInputFilter()
- public CollectionInputFilter setIsRequired()
- public bool getIsRequired()
- public CollectionInputFilter setCount()
- public int getCount()
- public void setData()
- public void isValid()
- public void setValidationGroup()
- public void getInvalidInput()
- public void getValidInput()
- public void getValues()
- public void getRawValues()
- public void clearValues()
- public void clearRawValues()
- public void getMessages()
- // Inherited methods from InputFilter
- public InputFilter setFactory()
- public Factory getFactory()
- public InputFilter add()
- // Inherited methods from BaseInputFilter
- public void init()
- public int count()
- public InputFilterInterface add()
- public self replace()
- public InputInterface|InputFilterInterface get()
- public bool has()
- public InputFilterInterface remove()
- public InputFilterInterface setData()
- public bool isValid()
- protected bool validateInputs()
- public InputFilterInterface setValidationGroup()
- public array getInvalidInput()
- public array getValidInput()
- public mixed getValue()
- public array getValues()
- public mixed getRawValue()
- public array getRawValues()
- public array getMessages()
- protected void validateValidationGroup()
- protected void populate()
- public bool hasUnknown()
- public array getUnknown()
- public array getInputs()
Hierarchy
Extends
Constants
Name | Value |
---|---|
VALIDATE_ALL | 'INPUT_FILTER_ALL' |
Members
protected
- $collectionData
- $collectionInvalidInputs
- $collectionMessages
- $collectionRawValues
- $collectionValidInputs
- $collectionValues
- $count
- $data
- $factory — Zend\InputFilter\Factory
- $inputFilter — Zend\InputFilter\BaseInputFilter
- $inputs
- $invalidInputs
- $isRequired
- $validInputs
- $validationGroup
Methods
public
- clearRawValues() — Clear collectionRawValues
- clearValues() — Clear collectionValues
- getCount() — Get the count of data to validate, use the count of data by default
- getInputFilter() — Get the input filter used when looping the data
- getInvalidInput() — {@inheritdoc}
- getIsRequired() — Get if collection can be empty
- getMessages() — {@inheritdoc}
- getRawValues() — {@inheritdoc}
- getValidInput() — {@inheritdoc}
- getValues() — {@inheritdoc}
- isValid() — {@inheritdoc}
- setCount() — Set the count of data to validate
- setData() — {@inheritdoc}
- setInputFilter() — Set the input filter to use when looping the data
- setIsRequired() — Set if the collection can be empty
- setValidationGroup() — {@inheritdoc}
Inherited from Zend\InputFilter\InputFilter
public
- add() — Add an input to the input filter
- getFactory() — Get factory to use when adding inputs and filters by spec
- setFactory() — Set factory to use when adding inputs and filters by spec
Inherited from Zend\InputFilter\BaseInputFilter
protected
- populate() — Populate the values of all attached inputs
- validateInputs() — Validate a set of inputs against the current data
- validateValidationGroup() — Ensure all names of a validation group exist as input in the filter
public
- add() — Add an input to the input filter
- count() — Countable: number of inputs in this input filter
- get() — Retrieve a named input
- getInputs() — Get an array of all inputs
- getInvalidInput() — Return a list of inputs that were invalid.
- getMessages() — Return a list of validation failure messages
- getRawValue() — Retrieve a raw (unfiltered) value from a named input
- getRawValues() — Return a list of unfiltered values
- getUnknown() — Return the unknown input
- getValidInput() — Return a list of inputs that were valid.
- getValue() — Retrieve a value from a named input
- getValues() — Return a list of filtered values
- has() — Test if an input or input filter by the given name is attached
- hasUnknown() — Is the data set has unknown input ?
- init() — This function is automatically called when creating element with factory. It allows to perform various operations (add elements...)
- isValid() — Is the data set valid?
- remove() — Remove a named input
- replace() — Replace a named input
- setData() — Set data to use when validating and filtering
- setValidationGroup() — Provide a list of one or more elements indicating the complete set to validate