Class Ingo_Storage

Ingo_Storage:: defines an API to store the various filter rules.

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_Mock, Ingo_Storage_Prefs, Ingo_Storage_Sql

Package: Ingo
Author: Michael Slusarz slusarz@horde.org
Author: Jan Schneider jan@horde.org
Located at Storage.php

Methods summary
`public static mixed`	# `factory( string $driver = null, array $params = null )` Attempts to return a concrete Ingo_Storage instance based on $driver. Attempts to return a concrete Ingo_Storage instance based on $driver. Parameters `$driver` <p>The type of concrete Ingo_Storage subclass to return. This is based on the storage driver ($driver). The code is dynamically included.</p> `$params` <p>A hash containing any additional configuration or connection parameters a subclass might need.</p> Returns `mixed` The newly created concrete Ingo_Storage instance, or false on an error.
`public`	# `__construct( )` Constructor. Constructor.
`public`	# `shutdown( )` Shutdown function. Shutdown function.
`public Ingo_Storage_Rule\|Ingo_Storage_Filters`	# `retrieve( integer $field, boolean $cache = true, boolean $readonly = false )` Retrieves the specified data. Retrieves the specified data. Parameters `$field` <p>The field name of the desired data (ACTION_* constants).</p> `$cache` Use the cached object? `$readonly` Whether to disable any write operations. Returns `Ingo_Storage_Rule\|Ingo_Storage_Filters` The specified object. Throws `Ingo_Exception`
`public`	# `store( Ingo_Storage_Rule\|Ingo_Storage_Filters $ob, boolean $cache = true )` Stores the specified data. Stores the specified data. Parameters `$ob` The object to store. `$cache` Cache the object? Throws `Ingo_Exception`
`public stdClass`	# `getActionInfo( integer $action )` Returns information on a given action constant. Returns information on a given action constant. Parameters `$action` The ACTION_* value. Returns `stdClass` Object with the following values: 'flags' => (boolean) Does this action allow flags to be set? 'label' => (string) The label for this action. 'type' => (string) Either 'folder', 'text', or empty.
`public stdClass`	# `getTestInfo( string $test )` Returns information on a given test string. Returns information on a given test string. Parameters `$test` $action The test string. Returns `stdClass` Object with the following values: 'label' => (string) The label for this action. 'type' => (string) Either 'int', 'none', or 'text'.
`public`	# `removeUserData( string $user )` Removes the user data from the storage backend. Stub for child class to override if it can implement. Removes the user data from the storage backend. Stub for child class to override if it can implement. Parameters `$user` The user name to delete filters for. Throws `Ingo_Exception`

Constants summary
`integer`	`COMBINE_ALL` Ingo_Storage:: 'combine' constants Ingo_Storage:: 'combine' constants	# `1`
`integer`	`COMBINE_ANY`	# `2`
`integer`	`ACTION_FILTERS` Ingo_Storage:: 'action' constants Ingo_Storage:: 'action' constants	# `0`
`integer`	`ACTION_KEEP`	# `1`
`integer`	`ACTION_MOVE`	# `2`
`integer`	`ACTION_DISCARD`	# `3`
`integer`	`ACTION_REDIRECT`	# `4`
`integer`	`ACTION_REDIRECTKEEP`	# `5`
`integer`	`ACTION_REJECT`	# `6`
`integer`	`ACTION_BLACKLIST`	# `7`
`integer`	`ACTION_VACATION`	# `8`
`integer`	`ACTION_WHITELIST`	# `9`
`integer`	`ACTION_FORWARD`	# `10`
`integer`	`ACTION_MOVEKEEP`	# `11`
`integer`	`ACTION_FLAGONLY`	# `12`
`integer`	`ACTION_NOTIFY`	# `13`
`integer`	`ACTION_SPAM`	# `14`
`integer`	`FLAG_ANSWERED` Ingo_Storage:: 'flags' constants Ingo_Storage:: 'flags' constants	# `1`
`integer`	`FLAG_DELETED`	# `2`
`integer`	`FLAG_FLAGGED`	# `4`
`integer`	`FLAG_SEEN`	# `8`
`integer`	`TYPE_HEADER` Ingo_Storage:: 'type' constants. Ingo_Storage:: 'type' constants.	# `1`
`integer`	`TYPE_SIZE`	# `2`
`integer`	`TYPE_BODY`	# `3`

Packages

Classes

Class Ingo_Storage

Direct known subclasses

Parameters

Returns

Parameters

Returns

Throws

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Throws