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

Class: TableRulesRegistry

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

Class Overview


Table rules registry


Variables

Methods



Class Details

[line 1284]
Table rules registry

Stores and executes table rules. The table rules allow to modify a Table object. This is the list of existing types of rules:

  • ColumnSelector: keeps only a set of columns
  • ColumnUnselector: remove a set of columns
  • ColumnReorder: reorder the columns
  • GroupFilter: modifies group title
  • TableFilter: modifies table title
  • ColumnFilter: modifies columns title
  • CellFilter: modifies content of cells one by one
  • CellFilterBatch: modifies content of all cells
  • RowUnselector: remove a set of rows
  • ColumnAdder: adds one or more columns and computes content of cells one by one
  • ColumnAdderBatch: adds one or more columns column and computes content of all cells




[ Top ]


Class Variables

$log =

[line 1299]



Tags:

access:  private

Type:   Logger


[ Top ]

$rules = array()

[line 1294]

All rules

 array ('Class_1' => array ('0' => Rule1, '1' => Rule2),




Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 1304]

TableRulesRegistry __construct( )

Constructor



Tags:

access:  public


[ Top ]

method addCellFilter [line 1394]

void addCellFilter( string $groupId, string $tableId, string $columnId, array $inputColumnIds, array $callback)

Adds a CellFilter rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
string   $columnId  
array   $inputColumnIds  
array   $callback  

[ Top ]

method addCellFilterBatch [line 1409]

void addCellFilterBatch( string $groupId, string $tableId, string $columnId, array $inputColumnIds, array $callback)

Adds a CellFilterBatch rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
string   $columnId  
array   $inputColumnIds  
array   $callback  

[ Top ]

method addColumnAdder [line 1449]

void addColumnAdder( string $groupId, string $tableId, ColumnPosition $columnPosition, array $newColumnIds, array $inputColumnIds, array $callback)

Adds a ColumnAdder rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
ColumnPosition   $columnPosition  
array   $newColumnIds  
array   $inputColumnIds  
array   $callback  

[ Top ]

method addColumnAdderBatch [line 1465]

void addColumnAdderBatch( string $groupId, string $tableId, ColumnPosition $columnPosition, array $newColumnIds, array $inputColumnIds, array $callback)

Adds a ColumnAdderBatch rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
ColumnPosition   $columnPosition  
array   $newColumnIds  
array   $inputColumnIds  
array   $callback  

[ Top ]

method addColumnFilter [line 1381]

void addColumnFilter( string $groupId, string $tableId, string $columnId, array $callback)

Adds a ColumnFilter rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
string   $columnId  
array   $callback  

[ Top ]

method addColumnReorder [line 1348]

void addColumnReorder( string $groupId, string $tableId, array $columnIds)

Adds a ColumnReorder rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
array   $columnIds  

[ Top ]

method addColumnSelector [line 1326]

void addColumnSelector( string $groupId, string $tableId, array $columnIds)

Adds a ColumnSelector rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
array   $columnIds  

[ Top ]

method addColumnUnselector [line 1337]

void addColumnUnselector( string $groupId, string $tableId, array $columnIds)

Adds a ColumnUnselector rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
array   $columnIds  

[ Top ]

method addGroupFilter [line 1358]

void addGroupFilter( string $groupId, array $callback)

Adds a GroupFilter rule



Tags:

access:  public


Parameters:

string   $groupId  
array   $callback  

[ Top ]

method addRowSelector [line 1435]

void addRowSelector( string $groupId, string $tableId, string $columnId, array $rowIds)

Adds a RowSelector rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
string   $columnId  
array   $rowIds  

[ Top ]

method addRowUnselector [line 1423]

void addRowUnselector( string $groupId, string $tableId, string $columnId, array $rowIds)

Adds a RowUnselector rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
string   $columnId  
array   $rowIds  

[ Top ]

method addRule [line 1312]

void addRule( BaseRule $rule)

Adds a rule in list



Tags:

access:  protected


Parameters:

BaseRule   $rule  

[ Top ]

method addTableFilter [line 1369]

void addTableFilter( string $groupId, string $tableId, array $callback)

Adds a TableFilter rule



Tags:

access:  public


Parameters:

string   $groupId  
string   $tableId  
array   $callback  

[ Top ]

method applyRules [line 1479]

void applyRules( array $groups)

Main method to apply rules on a table

Applies all table rules on tables and all column rules on columns.




Tags:

access:  public


Parameters:

array   $groups  

[ Top ]


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