CorePlugins
[ class tree: CorePlugins ] [ index: CorePlugins ] [ all elements ]

Class: ColumnSelector

Source Location: /coreplugins/tables/common/TableRulesRegistry.php

Class Overview

BaseRule
   |
   --GroupRule
      |
      --TableRule
         |
         --ColumnSelector

Rule to keep only a set of columns (include)


Variables

Methods


Child classes:

ColumnUnselector
Rule to keep only a set of columns (exclude)

Inherited Constants

Inherited Variables

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 400]
Rule to keep only a set of columns (include)



[ Top ]


Class Variables

$columnIds =

[line 405]



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 413]

ColumnSelector __construct( string $groupId, string $tableId, array $columnIds)

Constructor



Tags:

access:  public


Overrides BaseRule::__construct() (Constructor)

Parameters:

string   $groupId  
string   $tableId  
array   $columnIds  

[ Top ]

method applyRule [line 463]

void applyRule( Table $table, array $params)

Executes a rule on a table



Tags:

access:  public


Overridden in child classes as:

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

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

Parameters:

Table   $table  
array   $params  

[ Top ]

method selectColumns [line 423]

void selectColumns( mixed $table, [mixed $exclude = false])

Keeps or exclude columns



Tags:

access:  protected


[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:58 +0200 by phpDocumentor 1.3.0RC3