class IP extends Rule implements RuleInterface

IP rule.

Traits

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

Properties

protected I18n $i18n I18n. from I18nAwareTrait
protected string|null $version IP version.
protected array $i18nParameters I18n parameters.

Methods

setI18n(I18n $i18n)

{@inheritdoc}

string
translateFieldName(string $field, string $package)

Returns a translated field name.

array
getI18nParameters(string $field, string $package)

Gets the i18n parameters.

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

{@inheritdoc}

__construct(string|null $version = null)

Constructor.

int|null
getFlags()

Returns the filter flags.

string
getVersion()

Returns the name of the IP version that we're validating.

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 41
setI18n(I18n $i18n)

{@inheritdoc}

Parameters

I18n $i18n

in I18nAwareTrait at line 55
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 76
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 102
getTranslatedErrorMessage(string $field, string $rule, string|null $package = null)

{@inheritdoc}

Parameters

string $field
string $rule
string|null $package

validateWhenEmpty()

{@inheritdoc}

at line 35
__construct(string|null $version = null)

Constructor.

Parameters

string|null $version IP version

at line 53
protected int|null getFlags()

Returns the filter flags.

Return Value

int|null

Exceptions

RuntimeException

at line 76
protected string getVersion()

Returns the name of the IP version that we're validating.

Return Value

string

at line 92
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 100
string getErrorMessage(string $field)

Returns an error message.

Parameters

string $field Field name

Return Value

string