Overview

Namespaces

  • None
  • Wei
    • Validator

Classes

  • All
  • AllOf
  • Alnum
  • Alpha
  • BaseValidator
  • Between
  • Blank
  • Callback
  • CharLength
  • Chinese
  • Color
  • Contains
  • CreditCard
  • Date
  • DateTime
  • Decimal
  • Digit
  • Dir
  • DivisibleBy
  • DoubleByte
  • Email
  • EndsWith
  • EqualTo
  • Exists
  • FieldExists
  • File
  • GreaterThan
  • GreaterThanOrEqual
  • IdCardCn
  • IdCardHk
  • IdCardMo
  • IdCardTw
  • IdenticalTo
  • Image
  • In
  • Ip
  • Length
  • LessThan
  • LessThanOrEqual
  • Lowercase
  • Luhn
  • MaxLength
  • MinLength
  • MobileCn
  • NaturalNumber
  • NoneOf
  • Null
  • Number
  • OneOf
  • Password
  • Phone
  • PhoneCn
  • PlateNumberCn
  • PositiveInteger
  • PostcodeCn
  • Present
  • QQ
  • RecordExists
  • Regex
  • Required
  • SomeOf
  • StartsWith
  • Time
  • Tld
  • Type
  • Uppercase
  • Url
  • Uuid
  • Overview
  • Namespace
  • Class

Class BaseValidator

The base class of validator

Wei\Base
Extended by Wei\Validator\BaseValidator

Direct known subclasses

Wei\Validator\All, Wei\Validator\Between, Wei\Validator\Email, Wei\Validator\EndsWith, Wei\Validator\EqualTo, Wei\Validator\Exists, Wei\Validator\FieldExists, Wei\Validator\File, Wei\Validator\IdCardCn, Wei\Validator\IdCardHk, Wei\Validator\IdCardTw, Wei\Validator\In, Wei\Validator\Blank, Wei\Validator\Ip, Wei\Validator\Length, Wei\Validator\Lowercase, Wei\Validator\Luhn, Wei\Validator\NaturalNumber, Wei\Validator\Null, Wei\Validator\Number, Wei\Validator\Password, Wei\Validator\PositiveInteger, Wei\Validator\Present, Wei\Validator\Callback, Wei\Validator\RecordExists, Wei\Validator\Regex, Wei\Validator\Required, Wei\Validator\SomeOf, Wei\Validator\StartsWith, Wei\Validator\Type, Wei\Validator\Uppercase, Wei\Validator\Url, Wei\Validator\Contains, Wei\Validator\CreditCard, Wei\Validator\DateTime, Wei\Validator\Decimal, Wei\Validator\Dir, Wei\Validator\DivisibleBy

Indirect known subclasses

Wei\Upload, Wei\Validator\AllOf, Wei\Validator\GreaterThan, Wei\Validator\GreaterThanOrEqual, Wei\Validator\IdCardMo, Wei\Validator\IdenticalTo, Wei\Validator\Image, Wei\Validator\LessThan, Wei\Validator\LessThanOrEqual, Wei\Validator\MaxLength, Wei\Validator\MinLength, Wei\Validator\MobileCn, Wei\Validator\Alnum, Wei\Validator\NoneOf, Wei\Validator\OneOf, Wei\Validator\Phone, Wei\Validator\PhoneCn, Wei\Validator\PlateNumberCn, Wei\Validator\PostcodeCn, Wei\Validator\QQ, Wei\Validator\Time, Wei\Validator\Tld, Wei\Validator\Uuid, Wei\Validator\Alpha, Wei\Validator\CharLength, Wei\Validator\Chinese, Wei\Validator\Color, Wei\Validator\Date, Wei\Validator\Digit, Wei\Validator\DoubleByte
Abstract
Namespace: Wei\Validator
Author: Twin Huang twinhuang@qq.com
Located at Validator/BaseValidator.php
Methods summary
public boolean
# __invoke( mixed $input )

Validate the input value

Validate the input value

Parameters

$input

Returns

boolean
public
# isValid( $input )
abstract protected boolean
# doValidate( mixed $input )

Validate the input value (ignore the $negative property)

Validate the input value (ignore the $negative property)

Parameters

$input
The input to be validated

Returns

boolean
public array
# getMessages( string $name = null )

Returns the error messages

Returns the error messages

Parameters

$name
The name display in error message

Returns

array

Throws

UnexpectedValueException
When message contains unknown parameter
public string
# getJoinedMessage( string $separator = "\n", string $name = null )

Returns error message string

Returns error message string

Parameters

$separator
The string to connect messages
$name
The name display in error message

Returns

string
public string
# getFirstMessage( string $name = null )

Returns the first error message

Returns the first error message

Parameters

$name

Returns

string
public Wei\Validator\BaseValidator
# setMessages( array $messages )

Sets the specified messages

Sets the specified messages

Parameters

$messages

Returns

Wei\Validator\BaseValidator
public string
# getName( )

Returns message name

Returns message name

Returns

string
public Wei\Validator\BaseValidator
# setName( string $name )

Sets message name

Sets message name

Parameters

$name

Returns

Wei\Validator\BaseValidator
public array
# getErrors( )

Returns error definition

Returns error definition

Returns

array
public boolean
# hasError( string $name )

Returns whether the error defined

Returns whether the error defined

Parameters

$name

Returns

boolean
protected
# addError( string $name, string $customMessage = null )

Adds error definition

Adds error definition

Parameters

$name
The name of error
$customMessage
The custom error message
protected
# loadTranslationMessages( )

Loads the validator translation messages

Loads the validator translation messages

protected boolean
# isString( mixed $input )

Checks if the input value could be convert to string

Checks if the input value could be convert to string

Parameters

$input

Returns

boolean
protected
# storeOption( string|array $name, mixed $value = null )

Set property value

Set property value

Parameters

$name
The name of property
$value
The value of property
Methods inherited from Wei\Base
__call(), __construct(), __get(), getOption(), setOption()
Magic methods summary
public string
# t( string $message, array $parameters = array() )

Translates a message

Translates a message

Parameters

$message
$parameters

Returns

string
Properties summary
protected string $notStringMessage

The message added when the input required a stringify value

The message added when the input required a stringify value

# '%name% must be a string'
protected string $negativeMessage

The common message for negative validator

The common message for negative validator

# '%name% is not valid'
protected string $name

The name display in error message

The name display in error message

# 'This value'
protected boolean $negative

Whether it's a negative validator, for example, notDigit is digit's negative validator. The negative validator will returns $this->negativeMessage as the error message currently

Whether it's a negative validator, for example, notDigit is digit's negative validator. The negative validator will returns $this->negativeMessage as the error message currently

# false
protected array $errors

The error definition

The error definition

# array()
protected Wei\Validate $validator

The validate wei, available when this rule validator is invoked from validate wei

The validate wei, available when this rule validator is invoked from validate wei

#
Properties inherited from Wei\Base
$providers, $wei
Magic properties summary
public Wei\T $t

The translator wei

Wei Framework API documentation generated by ApiGen