EqualsValidator

EqualsValidator verifies if a parameter equals to a given value The input is compared to a value and the validator fails if they differ.

When the parameter ‘asparam’ is true, the content in ‘value’ is taken as a parameter name and the check is performed against it’s value otherwise the content in ‘value’ is taken. Parameters: ‘value’ value which the input should equals to ‘asparam’ whether the ‘value’ should be treated as a parameter name ‘strict’ whether or no to perform strict equality check (default: false)

Synopsis

class EqualsValidator extends Validator


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

Methods

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

getAcceptedParameters()

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

Returns the base Validator parameters plus ‘value’, ‘asparam’ and ‘strict’.

‘value’ is what every argument is compared against; leave it out and the first argument’s own value becomes the comparand, which turns the validator into an all-arguments-equal check. ‘asparam’ reinterprets ‘value’ as the name of another parameter and compares against that parameter’s value instead of the literal. ‘strict’ selects identity (===) over loose (==) comparison and 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.