Overview

Packages

  • Horde
    • Icalendar
      • UnitTests
  • Ingo
    • UnitTests
  • None

Classes

  • Horde_Core_Ui_VarRenderer_Ingo
  • Ingo
  • Ingo_Api
  • Ingo_Exception
  • Ingo_Exception_Pear
  • Ingo_LoginTasks_SystemTask_Upgrade
  • Ingo_Script
  • Ingo_Script_Imap
  • Ingo_Script_Imap_Api
  • Ingo_Script_Imap_Live
  • Ingo_Script_Maildrop
  • Ingo_Script_Maildrop_Comment
  • Ingo_Script_Maildrop_Recipe
  • Ingo_Script_Maildrop_Variable
  • Ingo_Script_Procmail
  • Ingo_Script_Procmail_Comment
  • Ingo_Script_Procmail_Recipe
  • Ingo_Script_Procmail_Variable
  • Ingo_Script_Sieve
  • Ingo_Script_Sieve_Action
  • Ingo_Script_Sieve_Action_Addflag
  • Ingo_Script_Sieve_Action_Discard
  • Ingo_Script_Sieve_Action_Fileinto
  • Ingo_Script_Sieve_Action_Flag
  • Ingo_Script_Sieve_Action_Keep
  • Ingo_Script_Sieve_Action_Notify
  • Ingo_Script_Sieve_Action_Redirect
  • Ingo_Script_Sieve_Action_Reject
  • Ingo_Script_Sieve_Action_Removeflag
  • Ingo_Script_Sieve_Action_Stop
  • Ingo_Script_Sieve_Action_Vacation
  • Ingo_Script_Sieve_Comment
  • Ingo_Script_Sieve_Else
  • Ingo_Script_Sieve_Elsif
  • Ingo_Script_Sieve_If
  • Ingo_Script_Sieve_Test
  • Ingo_Script_Sieve_Test_Address
  • Ingo_Script_Sieve_Test_Allof
  • Ingo_Script_Sieve_Test_Anyof
  • Ingo_Script_Sieve_Test_Body
  • Ingo_Script_Sieve_Test_Exists
  • Ingo_Script_Sieve_Test_False
  • Ingo_Script_Sieve_Test_Header
  • Ingo_Script_Sieve_Test_Not
  • Ingo_Script_Sieve_Test_Relational
  • Ingo_Script_Sieve_Test_Size
  • Ingo_Script_Sieve_Test_True
  • Ingo_Storage
  • Ingo_Storage_Blacklist
  • Ingo_Storage_Filters
  • Ingo_Storage_Filters_Sql
  • Ingo_Storage_Forward
  • Ingo_Storage_Mock
  • Ingo_Storage_Prefs
  • Ingo_Storage_Rule
  • Ingo_Storage_Spam
  • Ingo_Storage_Sql
  • Ingo_Storage_Vacation
  • Ingo_Storage_VacationTest
  • Ingo_Storage_Whitelist
  • Ingo_Test
  • Ingo_Transport
  • Ingo_Transport_Ldap
  • Ingo_Transport_Null
  • Ingo_Transport_Sivtest
  • Ingo_Transport_Timsieved
  • Ingo_Transport_Vfs
  • Overview
  • Package
  • Class
  • Tree

Class Ingo_Storage_Filters

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.

Direct known subclasses

Ingo_Storage_Filters_Sql
Package: Ingo
Author: Michael Slusarz slusarz@horde.org
Located at Storage/Filters.php
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 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

$id
A rule number.

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.

Disables a rule.

Parameters

$id
Number of the rule to disable.
public
# ruleEnable( integer $id )

Enables a rule.

Enables a rule.

Parameters

$id
Number of the rule to enable.
API documentation generated by ApiGen