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

Class: GroupFilter

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

Class Overview

BaseRule
   |
   --GroupRule
      |
      --GroupFilter

Rule to modify group title


Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

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 496]
Rule to modify group title

Callback method should have the following signature:

 static function myCallbackMethod('group_id', 'group_title')
   return 'group_new_title'




[ Top ]


Class Variables

$callback =

[line 507]

Callback method

Syntax is:

 array('PluginClass', 'myCallbackMethod')




Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 514]

GroupFilter __construct( string $groupId, array $callback)

Constructor



Tags:

access:  public


Overrides BaseRule::__construct() (Constructor)

Parameters:

string   $groupId  
array   $callback  

[ Top ]

method applyRule [line 525]

void applyRule( TableGroup $group, array $params)

Execute a rule on a group



Tags:

access:  public


Overrides GroupRule::applyRule() (Executes a rule on a group)

Parameters:

TableGroup   $group  
array   $params  

[ Top ]


Documentation generated on Mon, 13 Feb 2006 11:44:16 +0100 by phpDocumentor 1.3.0RC3