PHP Class Sam_Driver_Spamd_Sql, horde

Copyright 2003-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
Author: Chris Bowlby ([email protected])
Author: Max Kalika ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: extends Sam_Driver_Spamd_Base
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_db Horde_Db_Adapter Handle for the current database connection.

Public Methods

Method Description
__construct ( string $user, array $params = [] ) Constructor.
retrieve ( ) Retrieves user preferences and default values from the backend.
store ( boolean $defaults = false ) Stores user preferences and default values in the backend.

Protected Methods

Method Description
_retrieve ( boolean $defaults = false ) : array Retrieve an option set from the storage backend.

Method Details

__construct() public method

Constructor.
public __construct ( string $user, array $params = [] )
$user string A user name.
$params array Class parameters: - db: (Horde_Db_Adapater) A database handle. - table: (string) The name of the preference table. - global_user: (string, optional) A user name to use when setting global preferences. Defaults to '@GLOBAL'.

_retrieve() protected method

Retrieve an option set from the storage backend.
protected _retrieve ( boolean $defaults = false ) : array
$defaults boolean Whether to retrieve the global defaults instead of user options.
return array Array of option-value pairs.

retrieve() public method

Retrieves user preferences and default values from the backend.
public retrieve ( )

store() public method

Stores user preferences and default values in the backend.
public store ( boolean $defaults = false )
$defaults boolean Whether to store the global defaults instead of user options.

Property Details

$_db protected property

Handle for the current database connection.
protected Horde_Db_Adapter $_db
return Horde_Db_Adapter