Docs For Class Rule

Description

A Rule is a constraint on the operation of business systems.

A Rule is a constraint on the operation of business systems. They:

Constrain business strucuture.
Constrain busines operations, i.e., they determine the sequence of actions in business workflows.

Located in /Rule.php (line 19)

Direct descendents

Class	Description
ActivityRule	An ActivityRule represents a type of Rule that automatically executes an activity when it evaluates to TRUE.

Variable Summary

string $cannonicalName

string $description

array $elements

string $name

Method Summary

Rule __construct ([ $name = ''])

Rule Rule ([ $name = ''])

void addOperator (string $operator)

void addProposition (string $name, boolean $truthValue)

void addVariable (string $name, mixed $value)

Proposition evaluate (RuleContext $ruleContext)

string toString ()

Variables

string $cannonicalName (line 32)

The cannonical name of the Rule, i. the Rule.

The cannonical name of the Rule, i.e., the unique means of identifying the Rule. Namespace notation is recommended.

access: public

string $description (line 38)

Human-readable description of the Rule's purpose.

access: public

array $elements (line 45)

The RuleElements that comprise the Rule.

see: RuleElement
access: public

string $name (line 25)

The name of the Rule.

access: public

Methods

Constructor __construct (line 72)

Constructor initializes $name{$elements.

access: public

Rule __construct ([ $name = ''])

$name

Constructor Rule (line 63)

Constructor initializes $name{$elements.

access: public

Rule Rule ([ $name = ''])

$name

addOperator (line 100)

Adds an Operator to the array of $elements.

access: public

void addOperator (string $operator)

string $operator: The Boolean or quantifier operator.

addProposition (line 83)

Adds a Proposition to the array of $elements.

access: public

void addProposition (string $name, boolean $truthValue)

string $name: The Proposition's statement.
boolean $truthValue: Whether the Proposition is TRUE or FALSE.

addVariable (line 92)

Adds a Variable to the array of $elements.

access: public

void addVariable (string $name, mixed $value)

string $name: The Variable's name.
mixed $value: The Variable's value.

evaluate (line 111)

Evaluates a RuleContext. specific values. into the corresponding Propositions and Variables in the Rule.

Evaluates a RuleContext. The RuleContext contains Propositions and Variables that have specific values. To apply the context, simply copy these values into the corresponding Propositions and Variables in the Rule.

access: public

Proposition evaluate (RuleContext $ruleContext)

RuleContext $ruleContext

toString (line 297)

Returns an infixed, readable representation of the Rule.

access: public

string toString ()