SDK for PHP 3.x

ErrorRule extends AbstractRule
in package

A rule within a rule set. All rules contain a conditions property, which can be empty, and documentation about the rule.

Table of Contents

Methods

__construct()  : mixed
evaluate()  : null
If an error rule's conditions are met, raise an UnresolvedEndpointError containing the fully resolved error string.
getConditions()  : array<string|int, mixed>
getDocumentation()  : mixed
getError()  : array<string|int, mixed>

Methods

__construct()

public __construct(mixed $definition) : mixed
Parameters
$definition : mixed

evaluate()

If an error rule's conditions are met, raise an UnresolvedEndpointError containing the fully resolved error string.

public evaluate(array<string|int, mixed> $inputParameters, RulesetStandardLibrary $standardLibrary) : null
Parameters
$inputParameters : array<string|int, mixed>
$standardLibrary : RulesetStandardLibrary
Tags
throws
UnresolvedEndpointException
Return values
null

getConditions()

public getConditions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDocumentation()

public getDocumentation() : mixed

getError()

public getError() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page