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
Methods summary
public
|
#
__construct( Horde_Db_Adapter $db, array $params )
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
|
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
|
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
|
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
|
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
|
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
|
public
|
#
ruleDisable( integer $id )
Disables a rule.
Parameters
- $id
- Number of the rule to disable.
Overrides
|
public
|
#
ruleEnable( integer $id )
Enables a rule.
Parameters
- $id
- Number of the rule to enable.
Overrides
|