Inheritance diagram for Zend_Gdata_Gapps_Extension_Login:

Collaboration diagram for Zend_Gdata_Gapps_Extension_Login:

Public Member Functions
	__construct ($username=null, $password=null, $hashFunctionName=null, $admin=null, $suspended=null, $changePasswordAtNextLogin=null, $agreedToTerms=null)
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	getUsername ()
	setUsername ($value)
	getPassword ()
	setPassword ($value)
	getHashFunctionName ()
	setHashFunctionName ($value)
	getAdmin ()
	setAdmin ($value)
	getAgreedToTerms ()
	setAgreedToTerms ($value)
	getSuspended ()
	setSuspended ($value)
	getChangePasswordAtNextLogin ()
	setChangePasswordAtNextLogin ($value)
	__toString ()
Protected Member Functions
	takeAttributeFromDOM ($attribute)
Protected Attributes
	$_rootNamespace = 'apps'
	$_rootElement = 'login'
	$_username = null
	$_password = null
	$_hashFunctionName = null
	$_admin = null
	$_agreedToTerms = null
	$_suspended = null
	$_changePasswordAtNextLogin = null

Detailed Description

Definition at line 46 of file Login.php.

Constructor & Destructor Documentation

__construct	(	$	username = `null`,
		$	password = `null`,
		$	hashFunctionName = `null`,
		$	admin = `null`,
		$	suspended = `null`,
		$	changePasswordAtNextLogin = `null`,
		$	agreedToTerms = `null`
	)

Constructs a new Zend_Gdata_Gapps_Extension_Login object.

Parameters:

string	$username	(optional) The username to be used for this login.
string	$password	(optional) The password to be used for this login.
string	$hashFunctionName	(optional) The name of the hash function used to protect the password, or null if no has function has been applied. As of this writing, the only valid values are 'SHA-1' or null.
boolean	$admin	(optional) Whether the user is an administrator or not.
boolean	$suspended	(optional) Whether this login is suspended or not.
boolean	$changePasswordAtNextLogin	(optional) Whether the user is required to change their password at their next login.
boolean	$agreedToTerms	(optional) Whether the user has agreed to the terms of service.

Definition at line 131 of file Login.php.

Here is the call graph for this function:

Member Function Documentation

__toString ( )

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

Reimplemented from Zend_Gdata_App_Base.

Definition at line 476 of file Login.php.

Here is the call graph for this function:

getAdmin ( )

Get the value for this element's admin attribute.

See also:: setAdmin

Returns:: boolean The requested attribute.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 342 of file Login.php.

Here is the caller graph for this function:

getAgreedToTerms ( )

Get the value for this element's agreedToTerms attribute.

See also:: setAgreedToTerms

Returns:: boolean The requested attribute.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 376 of file Login.php.

Here is the caller graph for this function:

getChangePasswordAtNextLogin ( )

Get the value for this element's changePasswordAtNextLogin attribute.

See also:: setChangePasswordAtNextLogin

Returns:: boolean The requested attribute.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 444 of file Login.php.

getDOM	(	$	doc = `null`,
		$	majorVersion = `1`,
		$	minorVersion = `null`
	)

Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Parameters:

DOMDocument $doc The DOMDocument used to construct DOMElements

Returns:: DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_App_Base.

Definition at line 156 of file Login.php.

getHashFunctionName ( )

Get the value for this element's hashFunctionName attribute.

See also:: setHashFunctionName

Returns:: string The requested attribute.

Definition at line 314 of file Login.php.

Here is the caller graph for this function:

getPassword ( )

Get the value for this element's password attribute.

See also:: setPassword

Returns:: string The requested attribute.

Definition at line 288 of file Login.php.

Here is the caller graph for this function:

getSuspended ( )

Get the value for this element's suspended attribute.

See also:: setSuspended

Returns:: boolean The requested attribute.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 410 of file Login.php.

Here is the caller graph for this function:

getUsername ( )

Get the value for this element's username attribute.

See also:: setUsername

Returns:: string The attribute being modified.

Definition at line 263 of file Login.php.

Here is the caller graph for this function:

setAdmin ( $ value )

Set the value for this element's admin attribute. This indicates whether this user is an administrator for this domain.

Parameters:

boolean $value The desired value for this attribute.

Returns:: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 359 of file Login.php.

setAgreedToTerms ( $ value )

Set the value for this element's agreedToTerms attribute. This indicates whether this user has agreed to the terms of service.

Parameters:

boolean $value The desired value for this attribute.

Returns:: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 393 of file Login.php.

setChangePasswordAtNextLogin ( $ value )

Set the value for this element's changePasswordAtNextLogin attribute. If true, the user will be forced to set a new password the next time they login.

Parameters:

boolean $value The desired value for this attribute.

Returns:: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 462 of file Login.php.

setHashFunctionName ( $ value )

Set the value for this element's hashFunctionName attribute. This indicates whether the password supplied with setPassword() is in plaintext or has had a hash function applied to it. If null, plaintext is assumed. As of this writing, the only valid hash function is 'SHA-1'.

Parameters:

string $value The desired value for this attribute.

Returns:: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

Definition at line 329 of file Login.php.

setPassword ( $ value )

Set the value for this element's password attribute. As of this writing, this can be either be provided as plaintext or hashed using the SHA-1 algorithm for protection. If using a hash function, this must be indicated by calling setHashFunctionName().

Parameters:

string $value The desired value for this attribute.

Returns:: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

Definition at line 302 of file Login.php.

setSuspended ( $ value )

Set the value for this element's suspended attribute. If true, the user will not be able to login to this domain until unsuspended.

Parameters:

boolean $value The desired value for this attribute.

Returns:: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 427 of file Login.php.

setUsername ( $ value )

Set the value for this element's username attribute. This string is used to uniquely identify the user in this domian and is used to form this user's email address.

Parameters:

string $value The desired value for this attribute.

Returns:: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

Definition at line 276 of file Login.php.

takeAttributeFromDOM ( $ attribute ) [protected]

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

Parameters:

DOMNode $attribute The DOMNode attribute needed to be handled

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Reimplemented from Zend_Gdata_App_Base.

Definition at line 192 of file Login.php.

Field Documentation

$_admin = null [protected]

Definition at line 86 of file Login.php.

$_agreedToTerms = null [protected]

Definition at line 94 of file Login.php.

$_changePasswordAtNextLogin = null [protected]

Definition at line 109 of file Login.php.

$_hashFunctionName = null [protected]

Definition at line 78 of file Login.php.

$_password = null [protected]

Definition at line 66 of file Login.php.

$_rootElement = 'login' [protected]

Reimplemented from Zend_Gdata_App_Base.

Definition at line 50 of file Login.php.

$_rootNamespace = 'apps' [protected]

Reimplemented from Zend_Gdata_Extension.

Definition at line 49 of file Login.php.

$_suspended = null [protected]

Definition at line 101 of file Login.php.

$_username = null [protected]

Definition at line 58 of file Login.php.

The documentation for this class was generated from the following file:

C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/Gapps/Extension/Login.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation