• Home
• Valitron
• Validator

PHP Class Valitron\Validator

Validates input against certain criteria Show file Open project: vlucas/valitron Class Usage Examples

Protected Properties

Property	Type	Description
$_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

Public Methods

Method	Description
__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

Protected Methods

Method	Description
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

Method Details

Property Details