Documentation

ValidatorSet
in package

Validator set class

Tags
category

Pop

author

Nick Sagona, III dev@noladev.com

copyright

Copyright (c) 2009-2025 NOLA Interactive, LLC.

license

http://www.popphp.org/license New BSD License

version
4.5.0

Table of Contents

Constants

PASSED_ALL  = 1
PASSED_NONE  = 0
Constants
PASSED_SOME  = 2
STRICT_BOTH  = 3
STRICT_CONDITIONS_ONLY  = 2
STRICT_NONE  = 0
STRICT_VALIDATIONS_ONLY  = 1

Properties

$conditions  : array<string|int, mixed>
Conditions
$conditionStatus  : int|null
Condition status
$errors  : array<string|int, mixed>
Errors
$evaluated  : array<string|int, mixed>
Evaluated validators and their true/false results
$loaded  : array<string|int, mixed>
Load validators
$strict  : int
Strict flag
$validationStatus  : int|null
Validation status
$validators  : array<string|int, mixed>
Validators

Methods

add()  : ValidatorSet
Add validators
addCondition()  : ValidatorSet
Add condition
addConditionFromRule()  : ValidatorSet
Add condition from rule
addConditions()  : ValidatorSet
Add conditions
addConditionsFromRules()  : ValidatorSet
Add conditions from rules
addError()  : ValidatorSet
Add error
addValidator()  : ValidatorSet
Add validator
addValidatorFromRule()  : ValidatorSet
Add validator from rule
addValidators()  : ValidatorSet
Add validators to specific field
addValidatorsFromRules()  : ValidatorSet
Add validators from rules
addValidatorsToField()  : ValidatorSet
Add validators to specific field
createFromRules()  : ValidatorSet
Create validator set from rules
evaluate()  : bool
Evaluate all validators over the provided input data
evaluateConditions()  : bool
Evaluate all conditions over the provided input data
evaluateStatus()  : ValidatorSet
Evaluate status
getAvailableValidators()  : array<string|int, mixed>
Get available validators over the provided input data
getConditions()  : array<string|int, mixed>
Get conditions
getConditionStatus()  : int|null
Get condition status
getErrors()  : array<string|int, mixed>
Get errors
getEvaluated()  : mixed
Get evaluated
getLoadedValidators()  : array<string|int, mixed>
Get loaded validators
getStrict()  : int
Get strict
getValidationStatus()  : int|null
Get validation status
getValidators()  : array<string|int, mixed>
Get validators
hasConditions()  : bool
Has conditions
hasErrors()  : bool
Has errors
hasLoadedValidators()  : bool
Has loaded validators
hasValidators()  : bool
Has validators
isEvaluated()  : bool
Is evaluated
isLoaded()  : bool
Is loaded
isStrict()  : bool
Is strict
load()  : ValidatorSet
Load validator objects directly
loadValidator()  : ValidatorSet
Load validator
loadValidators()  : ValidatorSet
Load validators to specific field
loadValidatorsToField()  : ValidatorSet
Load validators to specific field
setStrict()  : ValidatorSet
Set strict

Constants

STRICT_CONDITIONS_ONLY

public mixed STRICT_CONDITIONS_ONLY = 2

STRICT_VALIDATIONS_ONLY

public mixed STRICT_VALIDATIONS_ONLY = 1

Properties

$conditions

Conditions

protected array<string|int, mixed> $conditions = []

$conditionStatus

Condition status

protected int|null $conditionStatus = null

$errors

Errors

protected array<string|int, mixed> $errors = []

$evaluated

Evaluated validators and their true/false results

protected array<string|int, mixed> $evaluated = []

$loaded

Load validators

protected array<string|int, mixed> $loaded = []

$validationStatus

Validation status

protected int|null $validationStatus = null

$validators

Validators

protected array<string|int, mixed> $validators = []

Methods

add()

Add validators

public static add(array<string|int, mixed>|string $validators[, string|null $field = null ][, int $strict = 3 ]) : ValidatorSet
Parameters
$validators : array<string|int, mixed>|string
$field : string|null = null
$strict : int = 3
Return values
ValidatorSet

addConditionFromRule()

Add condition from rule

public addConditionFromRule(string $rule[, string $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$rule : string
$prefix : string = 'Pop\Validator\'
Return values
ValidatorSet

addConditions()

Add conditions

public addConditions(array<string|int, mixed> $conditions) : ValidatorSet
Parameters
$conditions : array<string|int, mixed>
Return values
ValidatorSet

addConditionsFromRules()

Add conditions from rules

public addConditionsFromRules(array<string|int, mixed> $rules[, string $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$rules : array<string|int, mixed>
$prefix : string = 'Pop\Validator\'
Return values
ValidatorSet

addValidator()

Add validator

public addValidator(string $field, string $validator[, mixed $value = null ][, string|null $message = null ][, string|null $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$field : string
$validator : string
$value : mixed = null
$message : string|null = null
$prefix : string|null = 'Pop\Validator\'
Return values
ValidatorSet

addValidatorFromRule()

Add validator from rule

public addValidatorFromRule(string $rule[, string $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$rule : string
$prefix : string = 'Pop\Validator\'
Return values
ValidatorSet

addValidators()

Add validators to specific field

public addValidators(array<string|int, mixed> $validators[, string $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$validators : array<string|int, mixed>
$prefix : string = 'Pop\Validator\'
Return values
ValidatorSet

addValidatorsFromRules()

Add validators from rules

public addValidatorsFromRules(array<string|int, mixed> $rules[, string $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$rules : array<string|int, mixed>
$prefix : string = 'Pop\Validator\'
Return values
ValidatorSet

addValidatorsToField()

Add validators to specific field

public addValidatorsToField(string $field, array<string|int, mixed> $validators[, string $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$field : string
$validators : array<string|int, mixed>
$prefix : string = 'Pop\Validator\'
Return values
ValidatorSet

createFromRules()

Create validator set from rules

public static createFromRules(array<string|int, mixed>|string $rules[, int $strict = 3 ][, string $prefix = 'Pop\Validator\' ]) : ValidatorSet
Parameters
$rules : array<string|int, mixed>|string
$strict : int = 3
$prefix : string = 'Pop\Validator\'
Return values
ValidatorSet

evaluate()

Evaluate all validators over the provided input data

public evaluate(mixed $input[, string|null $prefix = 'Pop\Validator\' ]) : bool
Parameters
$input : mixed
$prefix : string|null = 'Pop\Validator\'
Return values
bool

evaluateConditions()

Evaluate all conditions over the provided input data

public evaluateConditions(mixed $input) : bool
Parameters
$input : mixed
Return values
bool

getAvailableValidators()

Get available validators over the provided input data

public static getAvailableValidators([string $directory = __DIR__ ][, array<string|int, mixed>|null $exclude = null ]) : array<string|int, mixed>
Parameters
$directory : string = __DIR__
$exclude : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>

getConditions()

Get conditions

public getConditions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getConditionStatus()

Get condition status

public getConditionStatus() : int|null
Return values
int|null

getErrors()

Get errors

public getErrors([string|null $field = null ]) : array<string|int, mixed>
Parameters
$field : string|null = null
Return values
array<string|int, mixed>

getEvaluated()

Get evaluated

public getEvaluated([string|null $field = null ]) : mixed
Parameters
$field : string|null = null

getLoadedValidators()

Get loaded validators

public getLoadedValidators([string|null $field = null ]) : array<string|int, mixed>
Parameters
$field : string|null = null
Return values
array<string|int, mixed>

getStrict()

Get strict

public getStrict() : int
Return values
int

getValidationStatus()

Get validation status

public getValidationStatus() : int|null
Return values
int|null

getValidators()

Get validators

public getValidators([string|null $field = null ]) : array<string|int, mixed>
Parameters
$field : string|null = null
Return values
array<string|int, mixed>

hasConditions()

Has conditions

public hasConditions() : bool
Return values
bool

hasErrors()

Has errors

public hasErrors([string|null $field = null ]) : bool
Parameters
$field : string|null = null
Return values
bool

hasLoadedValidators()

Has loaded validators

public hasLoadedValidators([string|null $field = null ]) : bool
Parameters
$field : string|null = null
Return values
bool

hasValidators()

Has validators

public hasValidators([string|null $field = null ]) : bool
Parameters
$field : string|null = null
Return values
bool

isEvaluated()

Is evaluated

public isEvaluated([string|null $field = null ]) : bool
Parameters
$field : string|null = null
Return values
bool

isLoaded()

Is loaded

public isLoaded([string|null $field = null ]) : bool
Parameters
$field : string|null = null
Return values
bool

isStrict()

Is strict

public isStrict() : bool
Return values
bool

load()

Load validator objects directly

public static load(array<string|int, mixed>|string $validators[, string|null $field = null ][, int $strict = 3 ]) : ValidatorSet
Parameters
$validators : array<string|int, mixed>|string
$field : string|null = null
$strict : int = 3
Return values
ValidatorSet

loadValidators()

Load validators to specific field

public loadValidators([array<string|int, mixed>|null $validators = null ][, array<string|int, mixed> $input = [] ]) : ValidatorSet
Parameters
$validators : array<string|int, mixed>|null = null
$input : array<string|int, mixed> = []
Tags
pparam

array $input

Return values
ValidatorSet

loadValidatorsToField()

Load validators to specific field

public loadValidatorsToField(string $field, array<string|int, mixed> $validators[, array<string|int, mixed> $input = [] ]) : ValidatorSet
Parameters
$field : string
$validators : array<string|int, mixed>
$input : array<string|int, mixed> = []
Return values
ValidatorSet 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results