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

TimeZone

class TimeZone extends Rule implements RuleInterface

Time zone rule.

Traits

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

Properties

protected I18n $i18n I18n. from I18nAwareTrait
protected int $group Time zone group.
protected string|null $country Country code.

Methods

RuleInterface
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
getTranslatedErrorMessage(string $field, string $rule, string|null $package = null)

Returns the translated error message.

from I18nAwareTrait
bool
validateWhenEmpty()

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

from DoesntValidateWhenEmptyTrait
__construct(int $group = DateTimeZone::ALL, string|null $country = null)

Constructor.

bool
validate(mixed $value, array $input)

Returns TRUE if the rule succeeds and FALSE if not.

string
getErrorMessage(string $field)

Returns an error message.

Details

in I18nAwareTrait at line 44
RuleInterface setI18n(I18n $i18n)

Sets the I18n instance.

Parameters

I18n $i18n I18n

Return Value

RuleInterface

in I18nAwareTrait at line 58
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 79
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 110
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

in DoesntValidateWhenEmptyTrait at line 22
bool validateWhenEmpty()

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

Return Value

bool

at line 42
__construct(int $group = DateTimeZone::ALL, string|null $country = null)

Constructor.

Parameters

int $group Time zone group
string|null $country Country code

at line 52
bool validate(mixed $value, array $input)

Returns TRUE if the rule succeeds and FALSE if not.

Parameters

mixed $value Value to validate
array $input Input

Return Value

bool

at line 60
string getErrorMessage(string $field)

Returns an error message.

Parameters

string $field Field name

Return Value

string