CorePlugins

# Class: ColumnRule Source Location: /coreplugins/tables/common/TableRulesRegistry.php
### Class Overview
    BaseRule
       |
       --GroupRule
          |
          --TableRule
             |
             --ColumnRule
Base rule for rules that will be applied on columns #### Author(s): | ### Variables $columnId | ### Constants WEIGHT_COLUMN_GLOBAL WEIGHT_COLUMN_PARTIAL WEIGHT_COLUMN_SINGLE | ### Methods applyRule applyRules checkRule getWeight
### Child classes: CellRule Base rule for rules that will be applied on cells ColumnFilter Rule to modify columns title | ### Inherited Constants #### Class: TableRule TableRule::WEIGHT_TABLE_GLOBAL TableRule::WEIGHT_TABLE_PARTIAL TableRule::WEIGHT_TABLE_SINGLE #### Class: GroupRule GroupRule::WEIGHT_GROUP_GLOBAL GroupRule::WEIGHT_GROUP_PARTIAL GroupRule::WEIGHT_GROUP_SINGLE #### Class: BaseRule BaseRule::WEIGHT_NO_MATCH | ### Inherited Variables #### Class: TableRule TableRule::$tableId #### Class: GroupRule GroupRule::$groupId #### Class: BaseRule BaseRule::$log | ### Inherited Methods #### Class: TableRule TableRule::applyRule() Executes a rule on a table TableRule::applyRules() Applies a set of rules on a table TableRule::checkRule() Checks a rule TableRule::getIndexes() Returns a map of index id's to their offset in the columnIds array. TableRule::getWeight() Computes weight #### Class: GroupRule GroupRule::addWeight() Stores computed weights GroupRule::applyRule() Executes a rule on a group GroupRule::applyRules() Applies a set of rules on a group GroupRule::checkRule() Checks a rule GroupRule::getWeight() Computes weight #### Class: BaseRule BaseRule::__construct() Constructor
### Class Details [line 305] Base rule for rules that will be applied on columns #### Tags:
abstract: |
[ Top ] ### Class Variables #### $columnId = [line 314] #### Tags:
access: | public
Type: | string
[ Top ] ### Class Methods ### method applyRule [line 368]
`void applyRule( Table $table, string $columnId, array $params)`
Executes a rule on a column Parameters are taken from the weights structure. #### Tags:
access: | public
see: | TableRule::addWeight()
Overridden in child classes as: 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 Overrides TableRule::applyRule() (Executes a rule on a table) #### Parameters:
Table | $table |
string | $columnId |
array | $params |
[ Top ] ### method applyRules [line 377]
`void applyRules( array $rules, string $groupId, string $columnId, Table $table)`
Applies a set of rules on a column #### Tags:
access: | public
static: |
Overrides TableRule::applyRules() (Applies a set of rules on a table) #### Parameters:
array | $rules | array of ColumnRule
string | $groupId |
string | $columnId |
Table | $table |
[ Top ] ### method checkRule [line 347]
`void checkRule( string $groupId, string $tableId, string $columnId, array &$weights)`
Checks a rule #### Tags:
access: | protected
Overrides TableRule::checkRule() (Checks a rule) #### Parameters:
string | $groupId |
string | $tableId |
string | $columnId |
array | &$weights |
[ Top ] ### method getWeight [line 323]
`void getWeight( string $groupId, string $tableId, string $columnId)`
Computes weight #### Tags:
access: | protected
see: | TableRule::getWeight()
Overrides TableRule::getWeight() (Computes weight) #### Parameters:
string | $groupId |
string | $tableId |
string | $columnId |
[ Top ] ### Class Constants #### WEIGHT_COLUMN_GLOBAL = 1 [line 309] [ Top ] #### WEIGHT_COLUMN_PARTIAL = 2 [line 308] [ Top ] #### WEIGHT_COLUMN_SINGLE = 4 [line 307] [ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:09 +0200 by phpDocumentor 1.3.0RC3