PHP Класс Valitron\Validator

Validates input against certain criteria
Автор: Vance Lucas ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$_errors array
$_fields array
$_instanceRuleMessage array Contains all rule messages that are available to the current valitron instance
$_instanceRules array Contains all rules that are available to the current valitron instance.
$_labels array
$_lang string
$_langDir string
$_ruleMessages array
$_rules array
$_validations array
$validUrlPrefixes array

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

Метод Описание
__construct ( array $data, array $fields = [], string $lang = null, string $langDir = null ) Setup validation
addInstanceRule ( string $name, mixed $callback, string $message = null ) Adds a new validation rule callback that is tied to the current instance only.
addRule ( string $name, mixed $callback, string $message = null ) Register new validation rule callback
data ( ) : array Get array of fields and data
error ( string $field, string $msg, array $params = [] ) Add an error to error messages array
errors ( null | string $field = null ) : array | boolean Get array of error messages
getUniqueRuleName ( $fields )
hasValidator ( string $name ) : boolean Returns true if either a valdiator with the given name has been registered or there is a default validator by that name.
label ( string $value )
labels ( array $labels = [] )
lang ( string $lang = null ) : string Get/set language to use for validation messages
langDir ( string $dir = null ) : string Get/set language file path
message ( string $msg ) Specify validation message to use for error for the last validation rule
reset ( ) Reset object properties
rule ( string | callback $rule, array $fields ) Convenience method to add a single validation rule
rules ( array $rules ) Convenience method to add multiple validation rules with an array
validate ( ) : boolean Run validations and return boolean result
withData ( array $data, array $fields = [] ) : Valitron Replace data on cloned instance

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

Метод Описание
assertRuleCallback ( $callback )
checkAndSetLabel ( string $field, string $msg, array $params ) : array
getPart ( $data, $identifiers )
getRuleMessages ( ) : array Returns all rule message, the static and instance ones.
getRules ( ) : array Returns all rule callbacks, the static and instance ones.
hasRule ( string $name, string $field ) : boolean Determine whether a field is being validated by the given rule.
stringLength ( string $value ) : integer | false Get the length of a string
validateAccepted ( string $field, mixed $value ) : boolean Validate that a field was "accepted" (based on PHP's string evaluation rules)
validateAlpha ( string $field, mixed $value ) : boolean Validate that a field contains only alphabetic characters
validateAlphaNum ( string $field, mixed $value ) : boolean Validate that a field contains only alpha-numeric characters
validateArray ( string $field, mixed $value ) : boolean Validate that a field is an array
validateBetween ( string $field, mixed $value, array $params ) : boolean Validate the size of a field is between min and max values
validateBoolean ( string $field, mixed $value ) : boolean Validate that a field contains a boolean.
validateContains ( string $field, mixed $value, array $params ) : boolean Validate a field contains a given string
validateCreditCard ( string $field, mixed $value, array $params ) : boolean Validate that a field contains a valid credit card optionally filtered by an array
validateDate ( string $field, mixed $value ) : boolean Validate that a field is a valid date
validateDateAfter ( string $field, mixed $value, array $params ) : boolean Validate the date is after a given date
validateDateBefore ( string $field, mixed $value, array $params ) : boolean Validate the date is before a given date
validateDateFormat ( string $field, mixed $value, array $params ) : boolean Validate that a field matches a date format
validateDifferent ( string $field, mixed $value, array $params ) : boolean Validate that a field is different from another field
validateEmail ( string $field, mixed $value ) : boolean Validate that a field is a valid e-mail address
validateEquals ( string $field, mixed $value, array $params ) : boolean Validate that two values match
validateIn ( string $field, mixed $value, array $params ) : boolean Validate a field is contained within a list of values
validateInstanceOf ( $field, $value, $params )
validateInteger ( string $field, mixed $value ) : boolean Validate that a field is an integer
validateIp ( string $field, mixed $value ) : boolean Validate that a field is a valid IP address
validateLength ( string $field, mixed $value, array $params ) : boolean Validate the length of a string
validateLengthBetween ( string $field, mixed $value, array $params ) : boolean Validate the length of a string (between)
validateLengthMax ( string $field, mixed $value, array $params ) : boolean Validate the length of a string (max)
validateLengthMin ( string $field, mixed $value, array $params ) : boolean Validate the length of a string (min)
validateMax ( string $field, mixed $value, array $params ) : boolean Validate the size of a field is less than a maximum value
validateMin ( string $field, mixed $value, array $params ) : boolean Validate the size of a field is greater than a minimum value.
validateNotIn ( string $field, mixed $value, array $params ) : boolean Validate a field is not contained within a list of values
validateNumeric ( string $field, mixed $value ) : boolean Validate that a field is numeric
validateOptional ( $field, $value, $params ) Validate optional field
validateRegex ( string $field, mixed $value, array $params ) : boolean Validate that a field passes a regular expression check
validateRequired ( string $field, mixed $value ) : boolean Required field validator
validateSlug ( string $field, mixed $value ) : boolean Validate that a field contains only alpha-numeric characters, dashes, and underscores
validateUrl ( string $field, mixed $value ) : boolean Validate that a field is a valid URL by syntax
validateUrlActive ( string $field, mixed $value ) : boolean Validate that a field is an active URL by verifying DNS record

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

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

Setup validation
public __construct ( array $data, array $fields = [], string $lang = null, string $langDir = null )
$data array
$fields array
$lang string
$langDir string

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

Adds a new validation rule callback that is tied to the current instance only.
public addInstanceRule ( string $name, mixed $callback, string $message = null )
$name string
$callback mixed
$message string

addRule() публичный статический Метод

Register new validation rule callback
public static addRule ( string $name, mixed $callback, string $message = null )
$name string
$callback mixed
$message string

assertRuleCallback() защищенный статический Метод

protected static assertRuleCallback ( $callback )

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

protected checkAndSetLabel ( string $field, string $msg, array $params ) : array
$field string
$msg string
$params array
Результат array

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

Get array of fields and data
public data ( ) : array
Результат array

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

Add an error to error messages array
public error ( string $field, string $msg, array $params = [] )
$field string
$msg string
$params array

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

Get array of error messages
public errors ( null | string $field = null ) : array | boolean
$field null | string
Результат array | boolean

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

protected getPart ( $data, $identifiers )

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

Returns all rule message, the static and instance ones.
protected getRuleMessages ( ) : array
Результат array

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

Returns all rule callbacks, the static and instance ones.
protected getRules ( ) : array
Результат array

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

public getUniqueRuleName ( $fields )

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

Determine whether a field is being validated by the given rule.
protected hasRule ( string $name, string $field ) : boolean
$name string The name of the rule
$field string The name of the field
Результат boolean

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

Returns true if either a valdiator with the given name has been registered or there is a default validator by that name.
public hasValidator ( string $name ) : boolean
$name string
Результат boolean

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

public label ( string $value )
$value string

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

public labels ( array $labels = [] )
$labels array

lang() публичный статический Метод

Get/set language to use for validation messages
public static lang ( string $lang = null ) : string
$lang string
Результат string

langDir() публичный статический Метод

Get/set language file path
public static langDir ( string $dir = null ) : string
$dir string
Результат string

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

Specify validation message to use for error for the last validation rule
public message ( string $msg )
$msg string

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

Reset object properties
public reset ( )

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

Convenience method to add a single validation rule
public rule ( string | callback $rule, array $fields )
$rule string | callback
$fields array

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

Convenience method to add multiple validation rules with an array
public rules ( array $rules )
$rules array

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

Get the length of a string
protected stringLength ( string $value ) : integer | false
$value string
Результат integer | false

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

Run validations and return boolean result
public validate ( ) : boolean
Результат boolean

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

This validation rule implies the field is "required"
protected validateAccepted ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that a field contains only alphabetic characters
protected validateAlpha ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that a field contains only alpha-numeric characters
protected validateAlphaNum ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that a field is an array
protected validateArray ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate the size of a field is between min and max values
protected validateBetween ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate that a field contains a boolean.
protected validateBoolean ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate a field contains a given string
protected validateContains ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate that a field contains a valid credit card optionally filtered by an array
protected validateCreditCard ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate that a field is a valid date
protected validateDate ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate the date is after a given date
protected validateDateAfter ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate the date is before a given date
protected validateDateBefore ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate that a field matches a date format
protected validateDateFormat ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate that a field is different from another field
protected validateDifferent ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate that a field is a valid e-mail address
protected validateEmail ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that two values match
protected validateEquals ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate a field is contained within a list of values
protected validateIn ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

protected validateInstanceOf ( $field, $value, $params )

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

Validate that a field is an integer
protected validateInteger ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that a field is a valid IP address
protected validateIp ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate the length of a string
protected validateLength ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate the length of a string (between)
protected validateLengthBetween ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate the length of a string (max)
protected validateLengthMax ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate the length of a string (min)
protected validateLengthMin ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate the size of a field is less than a maximum value
protected validateMax ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate the size of a field is greater than a minimum value.
protected validateMin ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate a field is not contained within a list of values
protected validateNotIn ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Validate that a field is numeric
protected validateNumeric ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate optional field
protected validateOptional ( $field, $value, $params )

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

Validate that a field passes a regular expression check
protected validateRegex ( string $field, mixed $value, array $params ) : boolean
$field string
$value mixed
$params array
Результат boolean

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

Required field validator
protected validateRequired ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that a field contains only alpha-numeric characters, dashes, and underscores
protected validateSlug ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that a field is a valid URL by syntax
protected validateUrl ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Validate that a field is an active URL by verifying DNS record
protected validateUrlActive ( string $field, mixed $value ) : boolean
$field string
$value mixed
Результат boolean

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

Replace data on cloned instance
public withData ( array $data, array $fields = [] ) : Valitron
$data array
$fields array
Результат Valitron

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

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

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

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

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

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

Contains all rule messages that are available to the current valitron instance
protected array $_instanceRuleMessage
Результат array

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

Contains all rules that are available to the current valitron instance.
protected array $_instanceRules
Результат array

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

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

$_lang защищенное статическое свойство

protected static string $_lang
Результат string

$_langDir защищенное статическое свойство

protected static string $_langDir
Результат string

$_ruleMessages защищенное статическое свойство

protected static array $_ruleMessages
Результат array

$_rules защищенное статическое свойство

protected static array $_rules
Результат array

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

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

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

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