InarrayValidator

InArrayValidator verifies whether an input is one of a set of values Parameters: ‘values’ list of values that form the array ‘sep’ separator of values in the list ‘case’ verifies case sensitive if true ‘strict’ whether or not to do strict type comparisons with in_array()

Synopsis

class InarrayValidator extends Validator


Extends	`Validator`
Since	`1.0.0`
Source	`Validator/InarrayValidator.php`

Methods

Method	Description
`getAcceptedParameters(): array<int, string>`	Returns the base Validator parameters plus ‘values’, ‘sep’, ‘case’ and ‘strict’.

getAcceptedParameters()

public static function getAcceptedParameters(): array<int, string>

Returns the base Validator parameters plus ‘values’, ‘sep’, ‘case’ and ‘strict’.

‘values’ holds the allowed set, either as an array of scalars or as a single string that is split on ‘sep’ (which must then be a non-empty string). ‘case’ makes the comparison case-sensitive; when it is falsy both the input and the allowed values are lowercased first. ‘strict’ is the third argument to in_array(), so it turns the membership test into a type-strict one; it defaults to false.

Returns array``<``int``, ``string``> — The accepted parameter names.

Inherited methods

These come from an ancestor and are documented where they are declared.

Method	Declared in	Description
`appendParameter()`	`ParameterHolder`	Append a parameter.
`appendParameterByRef()`	`ParameterHolder`	Append a parameter by reference.
`clearParameters()`	`ParameterHolder`	Clear all parameters associated with this request.
`execute()`	`Validator`	Executes the validator.
`getArguments()`	`Validator`	Returns all arguments which should be validated.
`getBase()`	`Validator`	Returns the base path of this validator.
`getBaseKeys()`	`Validator`	Returns the “keys” in the path of the base
`getContext()`	`Validator`	Retrieve the current application context.
`getDependencyManager()`	`Validator`	Returns the depency manager of the parent container if any.
`getFlatParameterNames()`	`ParameterHolder`	Retrieve an array of flattened parameter names.
`getLastKey()`	`Validator`	Returns the last “keys” in the path of the base
`getMutatedRequest()`	`Validator`	The WebRequest this validator ended execute() with.
`getName()`	`Validator`	Returns the name of this validator.
`getParameter()`	`ParameterHolder`	Retrieve a parameter.
`getParameterNames()`	`ParameterHolder`	Retrieve an array of parameter names.
`getParameters()`	`ParameterHolder`	Retrieve an array of parameters.
`getParentContainer()`	`Validator`	Retrieve the parent container.
`hasParameter()`	`ParameterHolder`	Indicates whether or not a parameter exists.
`initialize()`	`Validator`	Initialize this validator.
`mapErrorCode()`	`Validator`	Converts string severity codes into integer values (see severity constants) critical -> Validator::CRITICAL error -> Validator::ERROR notice -> Validator::NOTICE none -> Validator::NONE success -> not allowed to be specified by the user.
`removeParameter()`	`ParameterHolder`	Remove a parameter.
`reset()`	`Validator`	Returns the validator to its uninitialized state for reuse across requests.
`setErrorMessage()`	`Validator`	Sets an error message override for the given index (the empty string is the default/generic message).
`setParameter()`	`ParameterHolder`	Set a parameter.
`setParameterByRef()`	`ParameterHolder`	Set a parameter by reference.
`setParameters()`	`ParameterHolder`	Set an array of parameters.
`setParametersByRef()`	`ParameterHolder`	Set an array of parameters by reference.
`setParentContainer()`	`Validator`	Sets the parent container.
`shutdown()`	`Validator`	Shuts the validator down.