Class Net_IMSP_Options

Description

Net_IMSP_Options Class - provides an interface to IMSP server-based options storage.

Required parameters:

   'username'     Username to logon to IMSP server as.
   'password'     Password for current user.
   'auth_method'  The authentication method to use to login.
   'server'       The hostname of the IMSP server.
   'port'         The port of the IMSP server.

$Horde: framework/Net_IMSP/IMSP/Options.php,v 1.3.2.20 2009/01/06 15:23:27 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Net_IMSP/IMSP/Options.php (line 26)


	
			
Variable Summary
Method Summary
 Net_IMSP_Options Net_IMSP_Options (array $params)
 mixed get (string $optionName)
 mixed init ()
 void logout ()
 mixed set (string $optionName, string $optionValue)
 mixed setLogger (array $params)
Variables
Net_IMSP $_imsp (line 33)

Net_IMSP object.

array $_params (line 40)

Parameter list.

Methods
Constructor Net_IMSP_Options (line 47)

Constructor function.

Net_IMSP_Options Net_IMSP_Options (array $params)
  • array $params: Hash containing IMSP parameters.
get (line 83)

Function sends a GET command to IMSP server and retrieves values.

  • return: Associative array containing option=>value pairs or PEAR_Error.
mixed get (string $optionName)
  • string $optionName: Name of option to retrieve. Accepts '*' as wild card.
init (line 58)

Initialization function to be called after object is returned.

This allows errors to occur and not break the script.

  • return: True on success PEAR_Error on failure.
mixed init ()
logout (line 211)
void logout ()
set (line 157)

Function sets an option value on the IMSP server.

  • return: True or PEAR_Error.
mixed set (string $optionName, string $optionValue)
  • string $optionName: Name of option to set.
  • string $optionValue: Value to assign.
setLogger (line 202)

Sets the log information in the Net_IMSP object.

  • return: True on success PEAR_Error on failure.
mixed setLogger (array $params)
  • array $params: The log parameters.

Documentation generated on Sun, 30 Jan 2011 05:20:11 +0000 by phpDocumentor 1.4.3