Ingo_Storage_Filters 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.
Methods summary
public
integer
|
#
obType( )
Returns the object rule type.
Returns the object rule type.
Returns
integer
The object rule type.
|
public
|
#
setFilterlist( array $data )
Propagates the filter list with data.
Propagates the filter list with data.
Parameters
- $data
- A list of rule hashes.
|
public
array
|
#
getFilterList( )
Returns the filter list.
Returns
array
The list of rule hashes.
|
public
mixed
|
#
getFilter( mixed $id )
Return the filter entry for a given ID.
Return the filter entry for a given ID.
Returns
mixed
The rule hash entry, or false if not defined.
|
public
array
|
#
getRule( integer $id )
Returns a single rule hash.
Returns a single rule hash.
Parameters
Returns
array
The requested rule hash.
|
public
array
|
#
getDefaultRule( )
Returns a rule hash with default value used when creating new rules.
Returns a rule hash with default value used when creating new rules.
Returns
array
A rule hash.
|
public
integer
|
#
findRuleId( integer $action )
Searches for the first rule of a certain action type and returns its
number.
Searches for the first rule of a certain action type and returns its
number.
Parameters
- $action
- <p>The field type of the searched rule
(ACTION_* constants).</p>
Returns
integer
The number of the first matching rule or null.
|
public
array
|
#
findRule( integer $action )
Searches for and returns the first rule of a certain action type.
Searches for and returns the first rule of a certain action type.
Parameters
- $action
- <p>The field type of the searched rule
(ACTION_* constants).</p>
Returns
array
The first matching rule hash or null.
|
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>
|
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
|
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.
|
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.
|
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.
|
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.
|
public
|
#
ruleDisable( integer $id )
Disables a rule.
Parameters
- $id
- Number of the rule to disable.
|
public
|
#
ruleEnable( integer $id )
Enables a rule.
Parameters
- $id
- Number of the rule to enable.
|