1. class
  2. mako
  3. \
  4. validator
  5. \
  6. rules
  7. \
  8. Rule

Rule

abstract class Rule implements I18nAwareInterface

Base rule.

Traits

DoesntValidateWhenEmptyTrait
Doesn't validate when empty trait.
I18nAwareTrait
I18n aware trait.

Properties

protected I18n $i18n I18n. from I18nAwareTrait

Methods

bool
validateWhenEmpty()

Returns TRUE if the rule should be executed when the input is empty and FALSE if not.

from DoesntValidateWhenEmptyTrait
I18nAwareInterface
setI18n(I18n $i18n)

Sets the I18n instance.

from I18nAwareTrait
string
translateFieldName(string $field, string $package)

Returns a translated field name.

from I18nAwareTrait
array
getI18nParameters(string $field, string $package)

Gets the i18n parameters.

from I18nAwareTrait
string
getErrorMessage(string $field)

Returns an error message.

from I18nAwareTrait
string
getTranslatedErrorMessage(string $field, string $rule, string|null $package = null)

Returns the translated error message.

from I18nAwareTrait

Details

in DoesntValidateWhenEmptyTrait at line 20
bool validateWhenEmpty()

Returns TRUE if the rule should be executed when the input is empty and FALSE if not.

Return Value

bool

in I18nAwareTrait at line 42
I18nAwareInterface setI18n(I18n $i18n)

Sets the I18n instance.

Parameters

I18n $i18n I18n

Return Value

I18nAwareInterface

in I18nAwareTrait at line 56
protected string translateFieldName(string $field, string $package)

Returns a translated field name.

Parameters

string $field Field name
string $package Package prefix

Return Value

string

in I18nAwareTrait at line 77
protected array getI18nParameters(string $field, string $package)

Gets the i18n parameters.

Parameters

string $field Field name
string $package Package prefix

Return Value

array

in I18nAwareTrait at line 106
abstract string getErrorMessage(string $field)

Returns an error message.

Parameters

string $field Field name

Return Value

string

in I18nAwareTrait at line 116
string getTranslatedErrorMessage(string $field, string $rule, string|null $package = null)

Returns the translated error message.

Parameters

string $field Field name
string $rule Rule name
string|null $package Package name

Return Value

string