Validation class
Framework\Validation\Validation
Class Validation.
Defined in libraries/validation/src/Validation.php
Properties #
- $labels
- The labels used to replace field names.
- $rules
- The Validator rules.
- $errors
- The last errors.
- $messages
- Custom error messages.
- $validators
- The current Validators.
- $language
- The Language instance.
- $debugCollector
- -
$labels
protected array $labels = array (
)
The labels used to replace field names.
$rules
protected array $rules = array (
)
The Validator rules.
$errors
protected array $errors = array (
)
The last errors.
$messages
protected array $messages = array (
)
Custom error messages.
$validators
protected array $validators = array (
)
The current Validators.
$language
protected \Framework\Language\Language $language
The Language instance.
$debugCollector
protected \Framework\Validation\Debug\ValidationCollector $debugCollector
Methods #
- __construct()
- Validation constructor.
- getDebugCollector()
- -
- getError()
- Get latest error for a given field.
- getErrors()
- Get latest errors.
- getFilledMessage()
- -
- getLabel()
- Get the label for a given field.
- getLabels()
- Get a list of all labels.
- getLanguage()
- -
- getMessage()
- Get the custom error message from a field rule.
- getMessages()
- Get all custom error messages set.
- getRules()
- Get a list of current rules.
- getRuleset()
- -
- getValidators()
- -
- hasError()
- -
- isRuleAvailable()
- Tells if a rule is available in the current validators.
- reset()
- Reset the validation.
- setDebugCollector()
- -
- setError()
- -
- setLabel()
- Set label for a field.
- setLabels()
- Set fields labels.
- setLanguage()
- -
- setMessage()
- Set a custom error message for a field rule.
- setMessages()
- Set many custom error messages.
- setRule()
- Set rules for a given field.
- setRules()
- Set field rules.
- validate()
- Validate data with all rules.
- validateOnly()
- Validate only fields set on data.
- escapeArgs()
- -
- extractRules()
- -
- parseRule()
- -
- replaceArgs()
- Replace argument placeholders with data values.
- run()
- -
- setEqualsField()
- -
- validateField()
- -
- validateOnlySet()
- -
- validateRule()
- -
__construct()
public function __construct(?array $validators = NULL, ?\Framework\Language\Language $language = NULL)
Validation constructor.
Parameters
- ?array $validators
- ?\Framework\Language\Language $language
getDebugCollector()
public function getDebugCollector(): ?\Framework\Validation\Debug\ValidationCollector
Returns
?\Framework\Validation\Debug\ValidationCollector
getError()
public function getError(string $field): ?string
Get latest error for a given field.
Parameters
- string $field
Returns
?string
getErrors()
public function getErrors(): array
Get latest errors.
Returns
array
getFilledMessage()
public function getFilledMessage(string $field, string $rule, array $args = array (
)): string
Parameters
- string $field
- string $rule
- array $args
Returns
string
getLabel()
public function getLabel(string $field): ?string
Get the label for a given field.
Parameters
- string $field
Returns
?string
getLabels()
public function getLabels(): array
Get a list of all labels.
Returns
array
getLanguage()
public function getLanguage(): \Framework\Language\Language
Returns
\Framework\Language\Language
getMessage()
public function getMessage(string $field, string $rule): ?string
Get the custom error message from a field rule.
Parameters
- string $field - The field name
- string $rule - The rule name
Returns
?string
- The message string or null if the message is not set
getMessages()
public function getMessages(): array
Get all custom error messages set.
Returns
array
getRules()
public function getRules(): array
Get a list of current rules.
Returns
array
getRuleset()
public function getRuleset(): array
Returns
array
getValidators()
public function getValidators(): array
Returns
array
hasError()
public function hasError(string $field): bool
Parameters
- string $field
Returns
bool
isRuleAvailable()
public function isRuleAvailable(string $rule): bool
Tells if a rule is available in the current validators.
Parameters
- string $rule
Returns
bool
reset()
public function reset(): static
Reset the validation.
Returns
static
setDebugCollector()
public function setDebugCollector(\Framework\Validation\Debug\ValidationCollector $debugCollector): static
Parameters
- \Framework\Validation\Debug\ValidationCollector $debugCollector
Returns
static
setError()
public function setError(string $field, string $rule, array $args = array (
)): static
Parameters
- string $field
- string $rule
- array $args
Returns
static
setLabel()
public function setLabel(string $field, string $label): static
Set label for a field.
Parameters
- string $field
- string $label
Returns
static
setLabels()
public function setLabels(array $labels): static
Set fields labels.
Parameters
- array $labels - An associative array with fields as keys and label as values
Returns
static
setLanguage()
public function setLanguage(?\Framework\Language\Language $language = NULL): static
Parameters
- ?\Framework\Language\Language $language
Returns
static
setMessage()
public function setMessage(string $field, string $rule, string $message): static
Set a custom error message for a field rule.
Parameters
- string $field - The field name
- string $rule - The field rule name
- string $message - The custom error message for the field rule
Returns
static
setMessages()
public function setMessages(array $messages): static
Set many custom error messages.
Parameters
- array $messages - A multi-dimensional array with field names as keys and values as arrays where the keys are rule names and values are the custom error message strings
Returns
static
setRule()
public function setRule(string $field, array|string $rules): static
Set rules for a given field.
Parameters
- string $field
- array|string $rules
Returns
static
setRules()
public function setRules(array $rules): static
Set field rules.
Parameters
- array $rules - An associative array with field as keys and values as rules
Returns
static
validate()
public function validate(array $data): bool
Validate data with all rules.
Parameters
- array $data
Returns
bool
validateOnly()
public function validateOnly(array $data): bool
Validate only fields set on data.
Parameters
- array $data
Returns
bool
escapeArgs()
protected function escapeArgs(array $args): array
Parameters
- array $args
Returns
array
extractRules()
protected function extractRules(string $rules): array
Parameters
- string $rules
Returns
array
parseRule()
protected function parseRule(string $rule): array
Parameters
- string $rule
Returns
array
replaceArgs()
protected function replaceArgs(array $args, array $data): array
Replace argument placeholders with data values.
Parameters
- array $args
- array $data
Returns
array
run()
protected function run(array $fieldRules, array $data): bool
Parameters
- array $fieldRules
- array $data
Returns
bool
setEqualsField()
protected function setEqualsField(array $rule): array
Parameters
- array $rule
Returns
array
validateField()
protected function validateField(string $field, array $rules, array $data): bool
Parameters
- string $field
- array $rules
- array $data
Returns
bool
validateOnlySet()
protected function validateOnlySet(array $data): bool
Parameters
- array $data
Returns
bool
validateRule()
protected function validateRule(string $rule, string $field, array $args, array $data): bool
Parameters
- string $rule
- string $field
- array $args
- array $data
Returns
bool