Documentation

Validation
in package

Class Validation

Table of Contents

Methods

authorize()  : bool
Checks user authorisation to the action.
checkSafety()  : array<string|int, mixed>
filter()  : mixed
Filter value against a blueprint field definition.
filterIgnore()  : mixed
filterItem_List()  : array<string|int, mixed>
filterUnset()  : null
filterYaml()  : array<string|int, mixed>
typeArray()  : bool
Custom input: array
typeBool()  : bool
typeCheckbox()  : bool
HTML5 input: checkbox
typeCheckboxes()  : bool
Custom input: checkbox list
typeColor()  : bool
HTML5 input: color
typeCommaList()  : bool
typeDate()  : bool
HTML5 input: date
typeDatetime()  : bool
HTML5 input: datetime
typeDatetimeLocal()  : bool
HTML5 input: datetime-local
typeEmail()  : bool
HTML5 input: email
typeFile()  : bool
Custom input: file
typeHidden()  : bool
HTML5 input: hidden
typeIgnore()  : bool
Custom input: ignore (will not validate)
typeInt()  : bool
Custom input: int
typeList()  : bool
typeMonth()  : bool
HTML5 input: month
typeNumber()  : bool
HTML5 input: number
typePassword()  : bool
HTML5 input: password
typeRadio()  : bool
HTML5 input: radio
typeRange()  : bool
HTML5 input: range
typeSelect()  : bool
HTML5 input: select
typeText()  : bool
HTML5 input: text
typeTextarea()  : bool
HTML5 input: textarea
typeTime()  : bool
HTML5 input: time
typeToggle()  : bool
Custom input: toggle
typeUnset()  : bool
Input value which can be ignored.
typeUrl()  : bool
HTML5 input: url
typeWeek()  : bool
HTML5 input: week
validate()  : array<string|int, mixed>
Validate value against a blueprint field definition.
validateAlnum()  : bool
validateAlpha()  : bool
validateArray()  : bool
validateBool()  : bool
validateDigit()  : bool
validateFloat()  : bool
validateHex()  : bool
validateInt()  : bool
validateJson()  : bool
validatePattern()  : bool
validateRequired()  : bool
arrayFilterRecurse()  : array<string|int, mixed>
filterArray()  : array<string|int, mixed>|null
filterBool()  : bool
filterCheckbox()  : string|null
filterCheckboxes()  : array<string|int, mixed>|null
filterCommaList()  : array<string|int, mixed>|array<string|int, array<string|int, mixed>>|false|array<string|int, string>
filterDateTime()  : string
filterFile()  : array<string|int, mixed>
filterFlatten_array()  : array<string|int, mixed>|null
filterFloat()  : float
filterInt()  : int
filterLines()  : array<string|int, mixed>|array<string|int, array<string|int, mixed>>|false|array<string|int, string>
filterList()  : array<string|int, mixed>
filterLower()  : string
filterNumber()  : float|int
filterRange()  : float|int
filterText()  : string
filterUpper()  : string

Methods

authorize()

Checks user authorisation to the action.

public static authorize(string|array<string|int, string> $action[, UserInterface|null $user = null ]) : bool
Parameters
$action : string|array<string|int, string>
$user : UserInterface|null = null
Return values
bool

checkSafety()

public static checkSafety(mixed $value, array<string|int, mixed> $field) : array<string|int, mixed>
Parameters
$value : mixed
$field : array<string|int, mixed>
Return values
array<string|int, mixed>

filter()

Filter value against a blueprint field definition.

public static filter(mixed $value, array<string|int, mixed> $field) : mixed
Parameters
$value : mixed
$field : array<string|int, mixed>
Return values
mixed —

Filtered value.

filterIgnore()

public static filterIgnore(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : mixed
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>

filterItem_List()

public static filterItem_List(mixed $value, mixed $params) : array<string|int, mixed>
Parameters
$value : mixed
$params : mixed
Return values
array<string|int, mixed>

filterUnset()

public static filterUnset(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : null
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
null

filterYaml()

public static filterYaml(mixed $value, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$value : mixed
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

typeArray()

Custom input: array

public static typeArray(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeBool()

public static typeBool(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

typeCheckbox()

HTML5 input: checkbox

public static typeCheckbox(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeCheckboxes()

Custom input: checkbox list

public static typeCheckboxes(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeColor()

HTML5 input: color

public static typeColor(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeCommaList()

public static typeCommaList(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
bool

typeDate()

HTML5 input: date

public static typeDate(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeDatetime()

HTML5 input: datetime

public static typeDatetime(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeDatetimeLocal()

HTML5 input: datetime-local

public static typeDatetimeLocal(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeEmail()

HTML5 input: email

public static typeEmail(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeFile()

Custom input: file

public static typeFile(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeHidden()

HTML5 input: hidden

public static typeHidden(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeIgnore()

Custom input: ignore (will not validate)

public static typeIgnore(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeInt()

Custom input: int

public static typeInt(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeList()

public static typeList(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
bool

typeMonth()

HTML5 input: month

public static typeMonth(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeNumber()

HTML5 input: number

public static typeNumber(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typePassword()

HTML5 input: password

public static typePassword(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeRadio()

HTML5 input: radio

public static typeRadio(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeRange()

HTML5 input: range

public static typeRange(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeSelect()

HTML5 input: select

public static typeSelect(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeText()

HTML5 input: text

public static typeText(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeTextarea()

HTML5 input: textarea

public static typeTextarea(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeTime()

HTML5 input: time

public static typeTime(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeToggle()

Custom input: toggle

public static typeToggle(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeUnset()

Input value which can be ignored.

public static typeUnset(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeUrl()

HTML5 input: url

public static typeUrl(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

typeWeek()

HTML5 input: week

public static typeWeek(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : bool
Parameters
$value : mixed

Value to be validated.

$params : array<string|int, mixed>

Validation parameters.

$field : array<string|int, mixed>

Blueprint for the field.

Return values
bool —

True if validation succeeded.

validate()

Validate value against a blueprint field definition.

public static validate(mixed $value, array<string|int, mixed> $field) : array<string|int, mixed>
Parameters
$value : mixed
$field : array<string|int, mixed>
Return values
array<string|int, mixed>

validateAlnum()

public static validateAlnum(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateAlpha()

public static validateAlpha(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateArray()

public static validateArray(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateBool()

public static validateBool(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateDigit()

public static validateDigit(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateFloat()

public static validateFloat(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateHex()

public static validateHex(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateInt()

public static validateInt(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validateJson()

public static validateJson(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

validatePattern()

public static validatePattern(mixed $value, string $params) : bool
Parameters
$value : mixed
$params : string
Return values
bool

validateRequired()

public static validateRequired(mixed $value, bool $params) : bool
Parameters
$value : mixed
$params : bool
Return values
bool

arrayFilterRecurse()

protected static arrayFilterRecurse(array<string|int, mixed> $values, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$values : array<string|int, mixed>
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

filterArray()

protected static filterArray(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : array<string|int, mixed>|null
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
array<string|int, mixed>|null

filterBool()

protected static filterBool(mixed $value, mixed $params) : bool
Parameters
$value : mixed
$params : mixed
Return values
bool

filterCheckbox()

protected static filterCheckbox(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : string|null
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
string|null

filterCheckboxes()

protected static filterCheckboxes(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : array<string|int, mixed>|null
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
array<string|int, mixed>|null

filterCommaList()

protected static filterCommaList(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : array<string|int, mixed>|array<string|int, array<string|int, mixed>>|false|array<string|int, string>
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
array<string|int, mixed>|array<string|int, array<string|int, mixed>>|false|array<string|int, string>

filterDateTime()

protected static filterDateTime(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : string
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
string

filterFile()

protected static filterFile(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : array<string|int, mixed>
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
array<string|int, mixed>

filterFlatten_array()

protected static filterFlatten_array(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : array<string|int, mixed>|null
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
array<string|int, mixed>|null

filterFloat()

protected static filterFloat(mixed $value, mixed $params) : float
Parameters
$value : mixed
$params : mixed
Return values
float

filterInt()

protected static filterInt(mixed $value, mixed $params) : int
Parameters
$value : mixed
$params : mixed
Return values
int

filterLines()

protected static filterLines(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : array<string|int, mixed>|array<string|int, array<string|int, mixed>>|false|array<string|int, string>
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
array<string|int, mixed>|array<string|int, array<string|int, mixed>>|false|array<string|int, string>

filterList()

protected static filterList(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : array<string|int, mixed>
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
array<string|int, mixed>

filterLower()

protected static filterLower(mixed $value, array<string|int, mixed> $params) : string
Parameters
$value : mixed
$params : array<string|int, mixed>
Return values
string

filterNumber()

protected static filterNumber(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : float|int
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
float|int

filterRange()

protected static filterRange(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : float|int
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
float|int

filterText()

protected static filterText(mixed $value, array<string|int, mixed> $params, array<string|int, mixed> $field) : string
Parameters
$value : mixed
$params : array<string|int, mixed>
$field : array<string|int, mixed>
Return values
string

filterUpper()

protected static filterUpper(mixed $value, array<string|int, mixed> $params) : string
Parameters
$value : mixed
$params : array<string|int, mixed>
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results