Docs For Class Auth

method change_password [line 45]

void change_password(

$mPassword, [
$mUser = NULL], [
$mDomain = NULL])

bool change_password(string[[, string], string])

Change the password for the currently logged in user or a sub user

Tags:

access:

public

Parameters:

	$mPassword
	$mUser
	$mDomain

[ Top ]

method change_password_backend [line 49]

void change_password_backend(

$mPassword, 
$mUser, 
$mDomain)

Tags:

access:

public

Parameters:

	$mPassword
	$mUser
	$mDomain

[ Top ]

method create_soap_key [line 121]

string create_soap_key(
string
$mIpAddr)

string create_soap_key (string)

Generates a 512-bit SOAP key for use with invoking the Web Services in apnscp esprit. The key is a hexadecimal-encoded value traditionally split into groups of 8, or 96 bits per bunch, delimited by a '-'. When authenticating, this is the format preferred, but this function will instead return the 512-bit key gumped into one big string. At this time you are limited to just 10 keys.

Tags:

return:	512-bit 32-character long key
throws:	ArgumentError invalid IP address passed
privilege:	PRIVILEGE_SITE
access:	public

Parameters:

string

$mIpAddr

IP address of the client to use when creating the SOAP key

[ Top ]

method delete_soap_key [line 35]

void delete_soap_key(

$mKey)

Tags:

access:

public

Parameters:

$mKey

[ Top ]

method get_soap_keys [line 98]

array get_soap_keys(
)

array get_soap_keys (void)

Tags:

return:	An associative array of the following indexes are returned listing all keys associated to an account: key: the generated key last_used: an integer representation of the last date the key was used. If the key was never used, NULL is set for that value. Returns the list of SOAP keys associated to an account
privilege:	PRIVILEGE_SITE
access:	public

[ Top ]

method verify_authentication [line 153]

bool verify_authentication(

$mPassword)

bool verify_authentication (string)

Verifies password; not to be called by SOAP at all. Privileges prohibit such a call without a wrapper

Tags:

return:	whether the password matches or not
privilege:	PRIVILEGE_ALL\|PRIVILEGE_SERVER_EXEC
access:	public

Parameters:

$mPassword

[ Top ]

Class: Auth_Module

Class Overview

Variables

Methods

Class Details

Class Variables

$mysql =

Tags:

$pgsql =

Tags:

$seeded =

Tags:

Class Methods

method change_password [line 45]

Tags:

Parameters:

method change_password_backend [line 49]

Tags:

Parameters:

method create_soap_key [line 121]

Tags:

Parameters:

method delete_soap_key [line 35]

Tags:

Parameters:

method get_soap_keys [line 98]

Tags:

method verify_authentication [line 153]

Tags:

Parameters: