1. class
  2. Inphinit
  3. \
  4. Experimental
  5. \
  6. Validation
  7. \
  8. Rule

Rule

abstract class Rule (View source)

Properties

protected $failure
protected $alloweds
protected $messages

Methods

bool
exec(string $path, mixed $value, string|null $param, array $rules)

Executes the rule on a value.

isAllowed(array $rules)

Check if the rules are accepted

bool
passed()

Validate after set $failure

string|null
getFailure()

Returns a string if a failure occurs; otherwise, returns null

setMessage(string $type, string $message)

No description

Details

at line 30
abstract bool exec(string $path, mixed $value, string|null $param, array $rules)

Executes the rule on a value.

Parameters

string $path

Path of the field being validated
mixed $value

Value of the field (scalar); may be sanitized
string|null $param

Text after : in the rule (e.g. foo in rule:foo), or null if absent
array $rules

Other rules applied to the same field (name => parameter)

Return Value

bool

True if valid; false otherwise.

Exceptions

RuntimeException

at line 38
final protected isAllowed(array $rules)

Check if the rules are accepted

Parameters

array $rules

Exceptions

RuntimeException

at line 54
final protected bool passed()

Validate after set $failure

Return Value

bool

at line 64
final string|null getFailure()

Returns a string if a failure occurs; otherwise, returns null

Return Value

string|null

at line 74
final setMessage(string $type, string $message)

No description

Parameters

string $type

Message type
string $message Message

Exceptions

Exception