Class Ingo_Storage_Filters_Sql

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

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/apache.

Ingo_Storage_Filters

Ingo_Storage_Filters_Sql

Package: Ingo
Author: Jan Schneider jan@horde.org
Located at Storage/Filters/Sql.php

Methods summary
`public`	# `__construct( Horde_Db_Adapter $db, array $params )` Constructor. Constructor. Parameters `$db` Handle for the database connection. `$params` Driver specific parameters.
`public`	# `init( boolean $readonly = false )` Loads all rules from the DB backend. Loads all rules from the DB backend. Parameters `$readonly` Whether to disable any write operations.
`public`	# `addRule( array $rule, boolean $default = true )` Adds a rule hash to the filters list. Adds a rule hash to the filters list. Parameters `$rule` A rule hash. `$default` <p>If true merge the rule hash with default rule values.</p> Overrides `Ingo_Storage_Filters::addRule()`
`public`	# `updateRule( array $rule, integer $id )` Updates an existing rule with a rule hash. Updates an existing rule with a rule hash. Parameters `$rule` A rule hash `$id` A rule number Overrides `Ingo_Storage_Filters::updateRule()`
`public boolean`	# `deleteRule( integer $id )` Deletes a rule from the filters list. Deletes a rule from the filters list. Parameters `$id` Number of the rule to delete. Returns `boolean` True if the rule has been found and deleted. Overrides `Ingo_Storage_Filters::deleteRule()`
`public boolean`	# `copyRule( integer $id )` Creates a copy of an existing rule. Creates a copy of an existing rule. The created copy is added to the filters list right after the original rule. Parameters `$id` Number of the rule to copy. Returns `boolean` True if the rule has been found and copied. Overrides `Ingo_Storage_Filters::copyRule()`
`public`	# `ruleUp( integer $id, integer $steps = 1 )` Moves a rule up in the filters list. Moves a rule up in the filters list. Parameters `$id` Number of the rule to move. `$steps` Number of positions to move the rule up. Overrides `Ingo_Storage_Filters::ruleUp()`
`public`	# `ruleDown( integer $id, integer $steps = 1 )` Moves a rule down in the filters list. Moves a rule down in the filters list. Parameters `$id` Number of the rule to move. `$steps` Number of positions to move the rule down. Overrides `Ingo_Storage_Filters::ruleDown()`
`public`	# `ruleDisable( integer $id )` Disables a rule. Disables a rule. Parameters `$id` Number of the rule to disable. Overrides `Ingo_Storage_Filters::ruleDisable()`
`public`	# `ruleEnable( integer $id )` Enables a rule. Enables a rule. Parameters `$id` Number of the rule to enable. Overrides `Ingo_Storage_Filters::ruleEnable()`

Methods inherited from Ingo_Storage_Filters
`findRule(), findRuleId(), getDefaultRule(), getFilter(), getFilterList(), getRule(), obType(), setFilterlist()`

Packages

Classes

Class Ingo_Storage_Filters_Sql

Parameters

Parameters

Parameters

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Overrides

Parameters

Overrides

Parameters

Overrides

Parameters

Overrides