Class: TableFilter

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

Class Overview

BaseRule
   |
   --GroupRule
      |
      --TableRule
         |
         --TableFilter

Rule to modify table title

Variables

$callback

Methods

Child classes:

ColumnAdder: Rule to add one or more columns and compute content of cells one by one

Inherited Constants

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 542]
Rule to modify table title

Callback method should have the following signature:

 static function myCallbackMethod('table_id', 'table_title')
   return 'table_new_title'

[ Top ]

Class Variables

$callback =

[line 553]

Callback method

Syntax is:

 array('PluginClass', 'myCallbackMethod')

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

constructor __construct [line 561]

TableFilter __construct(
string
$groupId, string
$tableId, array
$callback)

Constructor

Parameters:

string	$groupId
string	$tableId
array	$callback

[ Top ]

method applyRule [line 573]

void applyRule(
Table
$table, array
$params)

Execute a rule on a table

Parameters:

Table	$table
array	$params

[ Top ]

Documentation generated on Fri, 21 Sep 2007 13:31:09 +0200 by phpDocumentor 1.3.0RC3