Docs For Class Ingo_Storage

Description

Ingo_Storage_filters is the object used to hold user-defined filtering rule information.

author: Michael Slusarz <slusarz@horde.org>
since: Ingo 1.0

Direct descendents

Class	Description
Ingo_Storage_filters_sql	Ingo_Storage_filters_sql is the object used to hold user-defined filtering rule information.

Variable Summary

array $_filters

integer $_obtype

Method Summary

void addRule (array $rule, [boolean $default = true])

boolean copyRule (integer $id)

boolean deleteRule (integer $id)

array findRule (integer $action)

integer findRuleId (integer $action)

array getDefaultRule ()

array getFilterlist ()

array getRule (integer $id)

integer obType ()

void ruleDisable (integer $id)

void ruleDown (integer $id, [integer $steps = 1])

void ruleEnable (integer $id)

void ruleUp (integer $id, [integer $steps = 1])

void setFilterlist (array $data)

void updateRule (array $rule, integer $id)

Variables

array $_filters = array() (line 828)

The filter list.

integer $_obtype = INGO_STORAGE_ACTION_FILTERS (line 835)

The object type.

Methods

addRule (line 939)

Adds a rule hash to the filters list.

void addRule (array $rule, [boolean $default = true])

array $rule: A rule hash.
boolean $default: If true merge the rule hash with default rule values.

Redefined in descendants as:

Ingo_Storage_filters_sql::addRule() : Adds a rule hash to the filters list.

copyRule (line 987)

Creates a copy of an existing rule.

The created copy is added to the filters list right after the original rule.

return: True if the rule has been found and copied.

boolean copyRule (integer $id)

integer $id: Number of the rule to copy.

Redefined in descendants as:

Ingo_Storage_filters_sql::copyRule() : Creates a copy of an existing rule.

deleteRule (line 966)

Deletes a rule from the filters list.

return: True if the rule has been found and deleted.

boolean deleteRule (integer $id)

integer $id: Number of the rule to delete.

Redefined in descendants as:

Ingo_Storage_filters_sql::deleteRule() : Deletes a rule from the filters list.

findRule (line 924)

Searches for and returns the first rule of a certain action type.

return: The first matching rule hash or null.

array findRule (integer $action)

integer $action: The field type of the searched rule (INGO_STORAGE_ACTION_* constants).

findRuleId (line 907)

Searches for the first rule of a certain action type and returns its number.

return: The number of the first matching rule or null.

integer findRuleId (integer $action)

integer $action: The field type of the searched rule (INGO_STORAGE_ACTION_* constants).

getDefaultRule (line 884)

Returns a rule hash with default value used when creating new rules.

return: A rule hash.

array getDefaultRule ()

getFilterlist (line 862)

Returns the filter list.

return: The list of rule hashes.

array getFilterlist ()

getRule (line 874)

Returns a single rule hash.

return: The requested rule hash.

array getRule (integer $id)

integer $id: A rule number.

obType (line 842)

Returns the object rule type.

return: The object rule type.

integer obType ()

ruleDisable (line 1046)

Disables a rule.

void ruleDisable (integer $id)

integer $id: Number of the rule to disable.

Redefined in descendants as:

Ingo_Storage_filters_sql::ruleDisable() : Disables a rule.

ruleDown (line 1025)

Moves a rule down in the filters list.

void ruleDown (integer $id, [integer $steps = 1])

integer $id: Number of the rule to move.
integer $steps: Number of positions to move the rule down.

Redefined in descendants as:

Ingo_Storage_filters_sql::ruleDown() : Moves a rule down in the filters list.

ruleEnable (line 1056)

Enables a rule.

void ruleEnable (integer $id)

integer $id: Number of the rule to enable.

Redefined in descendants as:

Ingo_Storage_filters_sql::ruleEnable() : Enables a rule.

ruleUp (line 1005)

Moves a rule up in the filters list.

void ruleUp (integer $id, [integer $steps = 1])

integer $id: Number of the rule to move.
integer $steps: Number of positions to move the rule up.

Redefined in descendants as:

Ingo_Storage_filters_sql::ruleUp() : Moves a rule up in the filters list.

setFilterlist (line 852)

Propagates the filter list with data.

void setFilterlist (array $data)

array $data: A list of rule hashes.

updateRule (line 954)

Updates an existing rule with a rule hash.

void updateRule (array $rule, integer $id)

array $rule: A rule hash
integer $id: A rule number

Redefined in descendants as:

Ingo_Storage_filters_sql::updateRule() : Updates an existing rule with a rule hash.