PHP Класс Jyxo\Input\Fluent

Allows chaining multiple validators and checking multiple values in one validation cycle.
Автор: Jakub Tománek
Показать файл Открыть проект

Открытые методы

Метод Описание
__construct ( ) Constructor.
__get ( string $offset ) : mixed Magic getter for easier retrieving of values.
all ( ) : self Validates all variables.
check ( mixed $var, string $name ) : self Starts a new value checking.
close ( ) : self Closes a chain.
condition ( string $name, mixed $param = null ) : self Adds a conditional chain.
defaultValue ( mixed $value ) : self Sets a default value in case the validation fails.
file ( string $index ) : self Checks file upload.
filter ( string $name, mixed $param = null ) : self Adds a filter to the chain.s
getErrors ( ) : array Returns errors.
getValue ( string $name ) : mixed Returns a value by name.
getValues ( ) : array Returns all values.
isValid ( boolean $assocErrors = false ) : boolean Performs validation and filtering of all variables.
post ( string $name, mixed $default = null ) : self Checks a POST variable.
query ( string $name, mixed $default = null ) : self Checks a GET variable.
request ( string $name, mixed $default = null ) : self Checks a POST/GET variable
validate ( string $name, string $errorMessage = null, mixed $param = null ) : self Adds a validator to the chain.
validateAll ( ) Calls isValid(), but throws an exception on error.
walk ( boolean $addFilter = true ) : self Adds a subchain to the current chain that treats the value a an array.

Приватные методы

Метод Описание
addToCheck ( array $global, string $name, mixed $default = null ) Adds a variable to the chain.
checkChain ( Chain $chain, mixed &$value, mixed $default, string $name = null ) : boolean Checks a chain.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( )

__get() публичный Метод

Magic getter for easier retrieving of values.
public __get ( string $offset ) : mixed
$offset string Value name
Результат mixed

all() публичный Метод

Validates all variables.
public all ( ) : self
Результат self

check() публичный Метод

Starts a new value checking.
public check ( mixed $var, string $name ) : self
$var mixed Value to check.
$name string Variable name
Результат self

close() публичный Метод

Closes a chain.
public close ( ) : self
Результат self

condition() публичный Метод

If there are conditions in the current chain, adds the condition as a subchain.
public condition ( string $name, mixed $param = null ) : self
$name string Validator name
$param mixed Additional validator parameter
Результат self

defaultValue() публичный Метод

Sets a default value in case the validation fails.
public defaultValue ( mixed $value ) : self
$value mixed Default value
Результат self

file() публичный Метод

Requires \Jyxo\Input\Upload.
См. также: Jyxo\Input\Upload
public file ( string $index ) : self
$index string File index
Результат self

filter() публичный Метод

Adds a filter to the chain.s
public filter ( string $name, mixed $param = null ) : self
$name string Filter name
$param mixed Additional filter parameter
Результат self

getErrors() публичный Метод

Returns errors.
public getErrors ( ) : array
Результат array

getValue() публичный Метод

Returns a value by name.
public getValue ( string $name ) : mixed
$name string Variable name
Результат mixed

getValues() публичный Метод

Returns all values.
public getValues ( ) : array
Результат array

isValid() публичный Метод

Performs validation and filtering of all variables.
public isValid ( boolean $assocErrors = false ) : boolean
$assocErrors boolean Return error messages in an associative array
Результат boolean

post() публичный Метод

Checks a POST variable.
public post ( string $name, mixed $default = null ) : self
$name string Variable name
$default mixed Default value
Результат self

query() публичный Метод

Checks a GET variable.
public query ( string $name, mixed $default = null ) : self
$name string Variable name
$default mixed Default value
Результат self

request() публичный Метод

Checks a POST/GET variable
public request ( string $name, mixed $default = null ) : self
$name string Variable name
$default mixed Default value
Результат self

validate() публичный Метод

Adds a validator to the chain.
public validate ( string $name, string $errorMessage = null, mixed $param = null ) : self
$name string Validator name
$errorMessage string Validator error message
$param mixed Additional validator parameter
Результат self

validateAll() публичный Метод

The exception contains only the first validation error message.
public validateAll ( )

walk() публичный Метод

Automatically adds the isArray validator.
public walk ( boolean $addFilter = true ) : self
$addFilter boolean Add the Trim filter (removes empty elements)
Результат self