PHP Class Sam_Driver_Spamd_Ftp, 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: Ben Chavet ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: extends Sam_Driver_Spamd_Base
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_vfs Horde_Vfs_Base VFS instance.

Public Methods

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

Protected Methods

Method Description
_parse ( string $config ) : array Parses the file into an option-value-hash.

Method Details

__construct() public method

Constructor.
public __construct ( string $user, array $params = [] )
$user string A user name.
$params array Class parameters: - vfs: (Horde_Vfs_Base) A VFS handle pointing to the FTP server. - user_prefs: (string) The file with the user preferences, relative to the home directory.

_parse() protected method

Parses the file into an option-value-hash.
protected _parse ( string $config ) : array
$config string The configuration file contents.
return array Hash with options and values.

retrieve() public method

Retrieves user preferences from the backend.
public retrieve ( )

store() public method

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

Property Details

$_vfs protected property

VFS instance.
protected Horde_Vfs_Base $_vfs
return Horde_Vfs_Base