PHP Класс Sirius\Validation\Validator

Наследование: implements Sirius\Validation\ValidatorInterface

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$dataWrapper	Sirius\Validation\DataWrapper\WrapperInterface	The object that will contain the data
$errorMessagePrototype	Sirius\Validation\ErrorMessage
$messages	array
$ruleFactory	RuleFactory
$rules	array
$wasValidated	boolean

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

Метод	Описание
__construct ( RuleFactory $ruleFactory = null, Sirius\Validation\ErrorMessage $errorMessagePrototype = null )
add ( string $selector, string \| callback $name = null, string \| array $options = null, string $messageTemplate = null, string $label = null ) : Validator
addMessage ( string $item, string $message = null ) : self
addMultiple ( array $selectorRulesCollection ) : Validator
clearMessages ( string $item = null ) : self	Clears the messages of an item
getDataWrapper ( mixed $data = null ) : Sirius\Validation\DataWrapper\WrapperInterface	The data wrapper will be used to wrap around the data passed to the validator This way you can validate anything, not just arrays (which is the default)
getErroMessagePrototype ( ) : Sirius\Validation\ErrorMessage	Retrieve the error message prototype
getMessages ( string $item = null ) : array
getRuleFactory ( ) : RuleFactory	Retrieve the rule factory
getRules ( )
remove ( string $selector, mixed $name = true, mixed $options = null ) : self
setData ( $data )
setErrorMessagePrototype ( Sirius\Validation\ErrorMessage $errorMessagePrototype ) : Sirius\Validation\Rule\AbstractValidator
validate ( mixed $data = null ) : boolean	Performs the validation

Защищенные методы

Метод	Описание
ensureSelectorRulesExist ( string $selector, string $label = null )

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

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

public __construct ( RuleFactory $ruleFactory = null, Sirius\Validation\ErrorMessage $errorMessagePrototype = null )
$ruleFactory	RuleFactory
$errorMessagePrototype	Sirius\Validation\ErrorMessage

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

public add ( string $selector, string \| callback $name = null, string \| array $options = null, string $messageTemplate = null, string $label = null ) : Validator
$selector	string
$name	string \| callback
$options	string \| array
$messageTemplate	string
$label	string
Результат	Validator

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

public addMessage ( string $item, string $message = null ) : self
$item	string	data identifier (eg: 'email', 'addresses[0][state]')
$message	string
Результат	self

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

public addMultiple ( array $selectorRulesCollection ) : Validator
$selectorRulesCollection	array
Результат	Validator

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

Clears the messages of an item

public clearMessages ( string $item = null ) : self
$item	string
Результат	self

ensureSelectorRulesExist() защищенный Метод

protected ensureSelectorRulesExist ( string $selector, string $label = null )
$selector	string
$label	string

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

The data wrapper will be used to wrap around the data passed to the validator This way you can validate anything, not just arrays (which is the default)

public getDataWrapper ( mixed $data = null ) : Sirius\Validation\DataWrapper\WrapperInterface
$data	mixed
Результат	Sirius\Validation\DataWrapper\WrapperInterface

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

Retrieve the error message prototype

public getErroMessagePrototype ( ) : Sirius\Validation\ErrorMessage
Результат	Sirius\Validation\ErrorMessage

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

public getMessages ( string $item = null ) : array
$item	string	key of the messages array (eg: 'password', 'addresses[0][line_1]')
Результат	array

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

Retrieve the rule factory

public getRuleFactory ( ) : RuleFactory
Результат	RuleFactory

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

public getRules ( )

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

public remove ( string $selector, mixed $name = true, mixed $options = null ) : self
$selector	string	data selector
$name	mixed	rule name or true if all rules should be deleted for that selector
$options	mixed	rule options, necessary for rules that depend on params for their ID
Результат	self

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

public setData ( $data )

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

public setErrorMessagePrototype ( Sirius\Validation\ErrorMessage $errorMessagePrototype ) : Sirius\Validation\Rule\AbstractValidator
$errorMessagePrototype	Sirius\Validation\ErrorMessage
Результат	Sirius\Validation\Rule\AbstractValidator

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

Performs the validation

public validate ( mixed $data = null ) : boolean
$data	mixed	array to be validated
Результат	boolean

Описание свойств

$dataWrapper защищенное свойство

The object that will contain the data

protected WrapperInterface,Sirius\Validation\DataWrapper $dataWrapper
Результат	Sirius\Validation\DataWrapper\WrapperInterface

$errorMessagePrototype защищенное свойство

protected ErrorMessage,Sirius\Validation $errorMessagePrototype
Результат	Sirius\Validation\ErrorMessage

$messages защищенное свойство

protected array $messages
Результат	array

$ruleFactory защищенное свойство

protected RuleFactory,Sirius\Validation $ruleFactory
Результат	RuleFactory

$rules защищенное свойство

protected array $rules
Результат	array

$wasValidated защищенное свойство

protected bool $wasValidated
Результат	boolean