Docs For Class GroupRule

void addWeight(
int
$weight, array
&$weights)

Stores computed weights

The array which contains weights has the following structure:

 Array ([0] => Array (['rule'] => Object (),
                      ['weights'] => Array (['param1'] => weight1,
                                            ['param2'] => weight2) ),
        [1] => Array (['rule'] => Object (),
                      ['weights'] => Array (['param3'] => weight3,
                                            ['param4'] => weight4) ) )

For most rules, there is only one element in the array and only one rule and weight defined. See ColumnAdder for an example of a more complicated rule.

Tags:

access:

protected

Overridden in child classes as:

ColumnAdder::addWeight(): Stores computed weights

Parameters:

int	$weight
array	&$weights

[ Top ]

void applyRule(
TableGroup
$group, array
$params)

Executes a rule on a group

Parameters are taken from the weights structure.

Tags:

access:	public
see:	GroupRule::addWeight()

Overridden in child classes as:

TableRule::applyRule(): Executes a rule on a table

ColumnRule::applyRule(): Executes a rule on a column

CellFilter::applyRule(): Execute a rule on cells of a column

CellFilterBatch::applyRule(): Execute a rule on cells of a column

ColumnFilter::applyRule(): Execute a rule on a column

ColumnSelector::applyRule(): Executes a rule on a table

ColumnUnselector::applyRule(): Executes a rule on a table

TableFilter::applyRule(): Execute a rule on a table

ColumnAdder::applyRule(): Execute a rule on table

ColumnAdderBatch::applyRule(): Execute a rule on table

RowUnselector::applyRule(): Execute a rule on each rows of a table

RowSelector::applyRule(): Executes a rule on every rows of a table

ColumnReorder::applyRule(): Executes a rule on a table

GroupFilter::applyRule(): Execute a rule on a group

Parameters:

TableGroup	$group
array	$params

[ Top ]

void applyRules(
array
$rules, TableGroup
$group)

Applies a set of rules on a group

Tags:

access:	public
static:

Overridden in child classes as:

TableRule::applyRules(): Applies a set of rules on a table

ColumnRule::applyRules(): Applies a set of rules on a column

Parameters:

array	$rules	array of GroupRule
TableGroup	$group

[ Top ]

void checkRule(
string
$groupId, array
&$weights)

Checks a rule

Tags:

access:

protected

Overridden in child classes as:

TableRule::checkRule(): Checks a rule

ColumnRule::checkRule(): Checks a rule

Parameters:

string	$groupId
array	&$weights

[ Top ]

int getWeight(
string
$groupId)

Computes weight

Weight is used to decide which rule will be executed. Group rules can be defined with following parameters:

'*': rule applies on all groups
'foo*': rule applies on groups with id starting with 'foo'
'bar': rule applies on group with id = 'bar'

Tags:

access:

protected

Overridden in child classes as:

TableRule::getWeight(): Computes weight

ColumnRule::getWeight(): Computes weight

Parameters:

string

$groupId

[ Top ]

Class: GroupRule

Class Overview

Author(s):

Variables

Constants

Methods

Child classes:

Inherited Constants

Class: BaseRule

Inherited Variables

Class: BaseRule

Inherited Methods

Class: BaseRule

Class Details

Tags:

Class Variables

$groupId =

Tags:

Class Methods

method addWeight [line 149]

Tags:

Parameters:

method applyRule [line 184]

Tags:

Parameters:

method applyRules [line 191]

Tags:

Parameters:

method checkRule [line 166]

Tags:

Parameters:

method getWeight [line 117]

Tags:

Parameters:

Class Constants

WEIGHT_GROUP_GLOBAL = 64

WEIGHT_GROUP_PARTIAL = 128

WEIGHT_GROUP_SINGLE = 256