ValidationManager

ValidationManager provides management for request parameters and their associated validators.

Synopsis

class ValidationManager extends ParameterHolder implements IValidatorContainer

Extends	ParameterHolder
Implements	IValidatorContainer
Since	1.0.0
Source	Validator/ValidationManager.php

Constants

Constant	Value	Description
MODE_CONDITIONAL	'conditional'	All request variables are available when no validation defined else only validated request variables are available.
MODE_RELAXED	'relaxed'	All request variables are always available.
MODE_STRICT	'strict'	Only validated request variables are available.

Methods

Method	Description
addArgumentResult(ValidationArgument $argument, int $result, Validator $validator = null): void	Adds a intermediate result of an validator for the given argument
addChild(Validator $validator): mixed	Adds a new child validator.
addFieldResult(Validator $validator, string $fieldname, int $result): void	Adds a validation result for a given field.
addIncident(ValidationIncident $incident): void	Adds an incident to the validation result.
clear(): void	Clears the validation manager for reuse clears the validator manager by resetting the dependency and error manager and removing all validators after calling their shutdown method so they can do a save shutdown.
[`createValidator(class-string $class, array<int	string, mixed> $arguments, array<string, string> $errors = [], array<string, mixed> $parameters = [], ?IValidatorContainer $parent = null): T&Validator`](#createvalidator)
execute(WebRequest $request): bool	Starts the validation process.
getBase(): VirtualArrayPath	Gets the base path of the validator.
getChild(string $name): mixed	Returns a named child validator.
getChilds(): array<string, Validator>	Returns all child validators.
getContext(): Context	Retrieve the current application context.
getDependencyManager(): DependencyManager	Returns the dependency manager.
getError(string $name): ?string	Retrieve an error message.
getErrorMessages(string $name = null): array<int, mixed>	Retrieve an array of error Messages.
getErrorNames(): array<int, string>	Retrieve an array of error names.
[`getErrors(string $name = null): array<string, mixed>	null`](#geterrors)
getFailedFields(int $minSeverity = null): array<int, string>	Returns all failed fields (this are all fields including those with severity none and notice).
getFieldErrorCode(string $fieldname, string $validatorName = null): ?int	Will return the highest error code for a field.
getFieldErrors(string $fieldname, int $minSeverity = null): array<int, ValidationError>	Returns all errors of a given field.
getFieldIncidents(string $fieldname, int $minSeverity = null): array<int, ValidationIncident>	Returns all incidents of a given field.
getIncidents(int $minSeverity = null): array<int, ValidationIncident>	Returns all incidents which happened during the execution of the validation.
getRawParameterSnapshot(): array<string, mixed>	Framework-internal accessor for the raw, unvalidated parameters as submitted, captured before any pruning by execute().
getReport(): ValidationReport	Retrieve the validation result report container of the last validation run.
getResult(): int	Returns the final validation result.
getSucceededFields(string $source): array<int, string>	Returns all fields which succeeded in the validation.
getValidatorFieldErrors(string $validatorName, string $fieldname, ?int $minSeverity = null): array<int, ValidationIncident>	Returns all errors of a given field in a given validator.
getValidatorIncidents(string $validatorName, int $minSeverity = null): array<int, ValidationIncident>	Returns all incidents of a given validator.
hasError(string $name): bool	Indicates whether or not a field has an error.
hasErrors(): bool	Indicates whether or not any errors exist.
hasIncidents(int $minSeverity = null): bool	Checks if any incidents occurred Returns all fields which succeeded in the validation.
initialize(Context $context, array<string, mixed> $parameters = []): void	initializes the validator manager.
isFieldFailed(string $fieldname): bool	Checks whether a field has failed in any validator.
isFieldValidated(string $fieldname): bool	Checks whether a field has been processed by a validator (this includes fields which were skipped because their value was not set and the validator was not required)
registerValidators(array<int, Validator> $validators): void	Registers multiple validators.
reset(): void	Returns the manager to its initial state for reuse across requests.
setError(string $name, string $message): void	Set an error.
setErrors(array<string, string> $errors): void	Set an array of errors If an existing error name matches any of the keys in the supplied array, the associated message will be appended to the messages array.
shutdown(): void	Shuts the validation system down.

addArgumentResult()

public function addArgumentResult(ValidationArgument $argument, int $result, Validator $validator = null): void

Adds a intermediate result of an validator for the given argument

The validator (if the error was caused inside a validator).

Parameter	Type	Description
$argument	ValidationArgument	The argument
$result	int	The arguments result.
$validator	Validator	The validator (if the error was caused inside a validator).

addChild()

public function addChild(Validator $validator): mixed

Adds a new child validator.

The new child validator.

Parameter	Type	Description
$validator	Validator	The new child validator.

Returns mixed

addFieldResult()

public function addFieldResult(Validator $validator, string $fieldname, int $result): void

Adds a validation result for a given field.

The result of the validation.

Parameter	Type	Description
$validator	Validator	The validator.
$fieldname	string	The name of the field which has been validated.
$result	int	The result of the validation.

addIncident()

public function addIncident(ValidationIncident $incident): void

Adds an incident to the validation result.

The incident.

Parameter	Type	Description
$incident	ValidationIncident	The incident.

clear()

public function clear(): void

Clears the validation manager for reuse clears the validator manager by resetting the dependency and error manager and removing all validators after calling their shutdown method so they can do a save shutdown.

createValidator()

public function createValidator(class-string<T> $class, array<int|string, mixed> $arguments, array<string, string> $errors = [], array<string, mixed> $parameters = [], ?IValidatorContainer $parent = null): T&Validator

Creates a new validator instance.

The parent (will use the validation manager if null is given)

Parameter	Type	Description
$class	class-string``<``T``>	The name of the class implementing the validator.
$arguments	`array<int“	string, mixed>`
$errors	array``<``string``, ``string``>	The error messages.
$parameters	array``<``string``, ``mixed``>	The validator parameters.
$parent	?IValidatorContainer	The parent (will use the validation manager if null is given)

Returns T``&Validator

execute()

public function execute(WebRequest $request): bool

Starts the validation process.

The data which should be validated.

Parameter	Type	Description
$request	WebRequest	The data which should be validated.

Returns bool — true, if validation succeeded.

getBase()

public function getBase(): VirtualArrayPath

Gets the base path of the validator.

Returns VirtualArrayPath — The base path.

getChild()

public function getChild(string $name): mixed

Returns a named child validator.

The name of the child validator.

Parameter	Type	Description
$name	string	The name of the child validator.

Returns mixed

getChilds()

public function getChilds(): array<string, Validator>

Returns all child validators.

Returns array``<``string``, Validator> — An array of Validator instances.

getContext()

final public function getContext(): Context

Retrieve the current application context.

Returns Context — The current Context instance.

getDependencyManager()

public function getDependencyManager(): DependencyManager

Returns the dependency manager.

Returns DependencyManager — The dependency manager instance.

getError()

public function getError(string $name): ?string

Retrieve an error message.

An error name.

Parameter	Type	Description
$name	string	An error name.

Returns ?``string — The error message, or null if there is no such error.

getErrorMessages()

public function getErrorMessages(string $name = null): array<int, mixed>

Retrieve an array of error Messages.

An optional error name.

Parameter	Type	Description
$name	string	An optional error name.

Returns array``<``int``, ``mixed``> — An indexed array of error messages (if a name was given) or an indexed array in this format: array(‘message’ => string, ‘errors’ => array(string))

getErrorNames()

public function getErrorNames(): array<int, string>

Retrieve an array of error names.

Returns array``<``int``, ``string``> — An indexed array of error names.

getErrors()

public function getErrors(string $name = null): array<string, mixed>|null

Retrieve an array of errors.

An optional error name.

Parameter	Type	Description
$name	string	An optional error name.

Returns array``<``string``, ``mixed``>``|``null — An associative array of errors(if no name was given) as an array with the error messages (key ‘messages’) and the validators (key ‘validators’) which failed.

getFailedFields()

public function getFailedFields(int $minSeverity = null): array<int, string>

Returns all failed fields (this are all fields including those with severity none and notice).

The minimum severity a field needs to have.

Parameter	Type	Description
$minSeverity	int	The minimum severity a field needs to have.

Returns array``<``int``, ``string``> — The names of the fields.

getFieldErrorCode()

public function getFieldErrorCode(string $fieldname, string $validatorName = null): ?int

Will return the highest error code for a field.

The Validator name

Parameter	Type	Description
$fieldname	string	The name of the field.
$validatorName	string	The Validator name

Returns ?``int — The error code, or null if the field was never touched by a validator.

getFieldErrors()

public function getFieldErrors(string $fieldname, int $minSeverity = null): array<int, ValidationError>

Returns all errors of a given field.

The minimum severity a returned incident of the error needs to have.

Parameter	Type	Description
$fieldname	string	The name of the field.
$minSeverity	int	The minimum severity a returned incident of the error needs to have.

Returns array``<``int``, ValidationError> — The errors.

getFieldIncidents()

public function getFieldIncidents(string $fieldname, int $minSeverity = null): array<int, ValidationIncident>

Returns all incidents of a given field.

The minimum severity a returned incident needs to have.

Parameter	Type	Description
$fieldname	string	The name of the field.
$minSeverity	int	The minimum severity a returned incident needs to have.

Returns array``<``int``, ValidationIncident> — The incidents.

getIncidents()

public function getIncidents(int $minSeverity = null): array<int, ValidationIncident>

Returns all incidents which happened during the execution of the validation.

The minimum severity a returned incident needs to have.

Parameter	Type	Description
$minSeverity	int	The minimum severity a returned incident needs to have.

Returns array``<``int``, ValidationIncident> — The incidents.

getRawParameterSnapshot()

public function getRawParameterSnapshot(): array<string, mixed>

Framework-internal accessor for the raw, unvalidated parameters as submitted, captured before any pruning by execute().

NOT reachable via WebRequest::getParameter()/getParameters() — this exists solely so FormPopulationEngine can redisplay a submitted value in an HTML form after a validation failure scrubbed it from the request (see the class docblock on $rawParameterSnapshot). Never use this for business logic.

Returns array``<``string``, ``mixed``>

getReport()

public function getReport(): ValidationReport

Retrieve the validation result report container of the last validation run.

Returns ValidationReport — The result report container.

getResult()

public function getResult(): int

Returns the final validation result.

Returns int — The result of the validation process.

getSucceededFields()

public function getSucceededFields(string $source): array<int, string>

Returns all fields which succeeded in the validation.

The source for which the fields should be returned.

Parameter	Type	Description
$source	string	The source for which the fields should be returned.

Returns array``<``int``, ``string``> — An array of field names.

getValidatorFieldErrors()

public function getValidatorFieldErrors(string $validatorName, string $fieldname, ?int $minSeverity = null): array<int, ValidationIncident>

Returns all errors of a given field in a given validator.

The minimum severity a returned incident of the error needs to have.

Parameter	Type	Description
$validatorName	string	The name of the validator.
$fieldname	string	The name of the field.
$minSeverity	?``int	The minimum severity a returned incident of the error needs to have.

Returns array``<``int``, ValidationIncident> — The incidents.

getValidatorIncidents()

public function getValidatorIncidents(string $validatorName, int $minSeverity = null): array<int, ValidationIncident>

Returns all incidents of a given validator.

The minimum severity a returned incident needs to have.

Parameter	Type	Description
$validatorName	string	The name of the validator.
$minSeverity	int	The minimum severity a returned incident needs to have.

Returns array``<``int``, ValidationIncident> — The incidents.

hasError()

public function hasError(string $name): bool

Indicates whether or not a field has an error.

A field name.

Parameter	Type	Description
$name	string	A field name.

Returns bool — true, if the field has an error, false otherwise.

hasErrors()

public function hasErrors(): bool

Indicates whether or not any errors exist.

Returns bool — true, if any error exist, otherwise false.

hasIncidents()

public function hasIncidents(int $minSeverity = null): bool

Checks if any incidents occurred Returns all fields which succeeded in the validation.

The minimum severity which shall be checked for.

Parameter	Type	Description
$minSeverity	int	The minimum severity which shall be checked for.

Returns bool — The result.

initialize()

public function initialize(Context $context, array<string, mixed> $parameters = []): void

initializes the validator manager.

The initialization parameters.

Parameter	Type	Description
$context	Context	The context instance.
$parameters	array``<``string``, ``mixed``>	The initialization parameters.

isFieldFailed()

public function isFieldFailed(string $fieldname): bool

Checks whether a field has failed in any validator.

The name of the field.

Parameter	Type	Description
$fieldname	string	The name of the field.

Returns bool — Whether the field has failed.

isFieldValidated()

public function isFieldValidated(string $fieldname): bool

Checks whether a field has been processed by a validator (this includes fields which were skipped because their value was not set and the validator was not required)

The name of the field.

Parameter	Type	Description
$fieldname	string	The name of the field.

Returns bool — Whether the field was validated.

registerValidators()

public function registerValidators(array<int, Validator> $validators): void

Registers multiple validators.

An array of validators.

Parameter	Type	Description
$validators	array``<``int``, Validator>	An array of validators.

reset()

public function reset(): void

Returns the manager to its initial state for reuse across requests.

Resets and then detaches every registered validator, clears the dependency manager, and installs a fresh report, so results and incidents from the previous run cannot leak into the next one. The manager’s own parameters are left alone; validators must be registered again before execute() has anything to run.

setError()

public function setError(string $name, string $message): void

Set an error.

An error message.

Parameter	Type	Description
$name	string	An error name.
$message	string	An error message.

setErrors()

public function setErrors(array<string, string> $errors): void

Set an array of errors If an existing error name matches any of the keys in the supplied array, the associated message will be appended to the messages array.

An associative array of errors and their associated messages.

Parameter	Type	Description
$errors	array``<``string``, ``string``>	An associative array of errors and their associated messages.

shutdown()

public function shutdown(): void

Shuts the validation system down.

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.
getFlatParameterNames()	ParameterHolder	Retrieve an array of flattened parameter names.
getParameter()	ParameterHolder	Retrieve a parameter.
getParameterNames()	ParameterHolder	Retrieve an array of parameter names.
getParameters()	ParameterHolder	Retrieve an array of parameters.
hasParameter()	ParameterHolder	Indicates whether or not a parameter exists.
removeParameter()	ParameterHolder	Remove a parameter.
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.