class Email extends Rule

Email address validation rule

Constants

INTEGER_TYPE

STRING_TYPE

FLOAT_TYPE

BOOLEAN_TYPE

NUMBER_TYPE

ITEMS_ARRAY

Properties

protected string|null $error Rule error from Rule
protected string|null $defaultError Default errror code from Rule
protected array $errorParams Error params from Rule
protected Collection $params Rule params from Rule

Methods

mixed
getType()

Return filter type

bool
validate(mixed $value)

Validate rule value callback

from Rule
__construct(array $params = [], string|null $error = null)

Constructor

void
setDefaultError(string $errorCode)

Set default error code

from Rule
Collection
getParams()

Return rule params

from Rule
boolean
isRequired()

Return true if field rule is required

from Rule
void
required(boolean $value = true)

Set rule required

from Rule
bool
validateType(mixed $value, int $type)

Validate field type

from Rule
void
setError(string|null $error, string|null $default = null)

Set validation error ode

from Rule
array
getErrorParams()

Get error params

from Rule
void
setErrorParams(array $params = [])

Set error params

from Rule
string|null
getError()

Return validation error code

from Rule

Details

at line 37
mixed getType()

Return filter type

Return Value

mixed

in Rule at line 68
bool validate(mixed $value)

Validate rule value callback

Parameters

mixed $value

Return Value

bool

at line 25
__construct(array $params = [], string|null $error = null)

Constructor

Parameters

array $params
string|null $error

in Rule at line 92
void setDefaultError(string $errorCode)

Set default error code

Parameters

string $errorCode

Return Value

void

in Rule at line 102
Collection getParams()

Return rule params

Return Value

Collection

in Rule at line 112
boolean isRequired()

Return true if field rule is required

Return Value

boolean

in Rule at line 123
void required(boolean $value = true)

Set rule required

Parameters

boolean $value

Return Value

void

in Rule at line 135
protected bool validateType(mixed $value, int $type)

Validate field type

Parameters

mixed $value
int $type

Return Value

bool

in Rule at line 174
void setError(string|null $error, string|null $default = null)

Set validation error ode

Parameters

string|null $error
string|null $default

Return Value

void

in Rule at line 185
array getErrorParams()

Get error params

Return Value

array

in Rule at line 196
void setErrorParams(array $params = [])

Set error params

Parameters

array $params

Return Value

void

in Rule at line 206
string|null getError()

Return validation error code

Return Value

string|null