## Zend_Gdata_Gapps_Extension_Login

Description

Represents the apps:login element used by the Apps data API. This class is used to describe properties of a user, and is usually contained within instances of Zene_Gdata_Gapps_UserEntry or any other class which is linked to a particular username.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Gdata/Gapps/Extension/Login.php (line 46)

    Zend_Gdata_App_Base
       |
       --Zend_Gdata_App_Extension
          |
          --Zend_Gdata_Extension
             |
             --Zend_Gdata_Gapps_Extension_Login

Variable Summary
boolean $_admin
boolean. $_agreedToTerms
boolean $_changePasswordAtNextLogin
string $_hashFunctionName
string $_password
mixed $_rootElement
mixed $_rootNamespace
boolean $_suspended
string $_username
Method Summary
Zend_Gdata_Gapps_Extension_Login __construct ([string $username = null], [string $password = null], [string $hashFunctionName = null], [boolean $admin = null], [boolean $suspended = null], [boolean $changePasswordAtNextLogin = null], [boolean $agreedToTerms = null])
boolean getAdmin ()
boolean getAgreedToTerms ()
boolean getChangePasswordAtNextLogin ()
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
string getHashFunctionName ()
string getPassword ()
boolean getSuspended ()
string getUsername ()
Zend_Gdata_Gapps_Extension_Login setAdmin (boolean $value)
Zend_Gdata_Gapps_Extension_Login setAgreedToTerms (boolean $value)
Zend_Gdata_Gapps_Extension_Login setChangePasswordAtNextLogin (boolean $value)
Zend_Gdata_Gapps_Extension_Login setHashFunctionName (string $value)
Zend_Gdata_Gapps_Extension_Login setPassword (string $value)
Zend_Gdata_Gapps_Extension_Login setSuspended (boolean $value)
Zend_Gdata_Gapps_Extension_Login setUsername (string $value)
void takeAttributeFromDOM (DOMNode $attribute)
void __toString ()
Variables
boolean $_admin = null (line 86)

True if the user has administrative rights for this domain, false otherwise.

- access: protected

boolean. $_agreedToTerms = null (line 94)

True if the user has agreed to the terms of service for Google Apps, false otherwise.

- access: protected

boolean $_changePasswordAtNextLogin = null (line 109)

True if the user will be required to change their password at their next login, false otherwise.

- access: protected

string $_hashFunctionName = null (line 78)

Specifies whether the password stored in _password is in cleartext or is an SHA-1 digest of a password. If the password is cleartext, then this should be null. If the password is an SHA-1 digest, then this should be set to 'SHA-1'.

At the time of writing, no other hash functions are supported

- access: protected

string $_password = null (line 66)

The password for the user. May be in cleartext or as an SHA-1 digest, depending on the value of _hashFunctionName.

- access: protected

mixed $_rootElement = 'login' (line 50)

- access: protected

Redefinition of:

Zend_Gdata_App_Base::$_rootElement

mixed $_rootNamespace = 'apps' (line 49)

- access: protected

Redefinition of:

Zend_Gdata_Extension::$_rootNamespace

boolean $_suspended = null (line 101)

True if this user has been suspended, false otherwise.

- access: protected

string $_username = null (line 58)

The username for this user. This is used as the user's email address and when logging in to Google Apps-hosted services.

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_App_Base

> Zend_Gdata_App_Base::$_extensionAttributes
> Zend_Gdata_App_Base::$_extensionElements
> Zend_Gdata_App_Base::$_namespaceLookupCache
> Zend_Gdata_App_Base::$_namespaces
> Zend_Gdata_App_Base::$_rootNamespaceURI
> Zend_Gdata_App_Base::$_text

Methods
Constructor __construct (line 131)

Constructs a new Zend_Gdata_Gapps_Extension_Login object.

- access: public

Zend_Gdata_Gapps_Extension_Login __construct ([string $username = null], [string $password = null], [string $hashFunctionName = null], [boolean $admin = null], [boolean $suspended = null], [boolean $changePasswordAtNextLogin = null], [boolean $agreedToTerms = null])

- 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.

Redefinition of:

Zend_Gdata_Extension::__construct()

getAdmin (line 342)

Get the value for this element's admin attribute.

- return: The requested attribute.
- see: Zend_Gdata_Gapps_Extension_Login::setAdmin()
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

boolean getAdmin ()
getAgreedToTerms (line 376)

Get the value for this element's agreedToTerms attribute.

- return: The requested attribute.
- see: Zend_Gdata_Gapps_Extension_Login::setAgreedToTerms()
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

boolean getAgreedToTerms ()
getChangePasswordAtNextLogin (line 444)

Get the value for this element's changePasswordAtNextLogin attribute.

- return: The requested attribute.
- see: Zend_Gdata_Gapps_Extension_Login::setChangePasswordAtNextLogin()
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

boolean getChangePasswordAtNextLogin ()
getDOM (line 156)

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.

- return: The DOMElement representing this element and all child properties.
- access: public

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

- DOMDocument $doc: The DOMDocument used to construct DOMElements
- $majorVersion
- $minorVersion

Redefinition of:

Zend_Gdata_App_Base::getDOM()
  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.

getHashFunctionName (line 314)

Get the value for this element's hashFunctionName attribute.

- return: The requested attribute.
- see: Zend_Gdata_Gapps_Extension_Login::setHashFunctionName()
- access: public

string getHashFunctionName ()
getPassword (line 288)

Get the value for this element's password attribute.

- return: The requested attribute.
- see: Zend_Gdata_Gapps_Extension_Login::setPassword()
- access: public

string getPassword ()
getSuspended (line 410)

Get the value for this element's suspended attribute.

- return: The requested attribute.
- see: Zend_Gdata_Gapps_Extension_Login::setSuspended()
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

boolean getSuspended ()
getUsername (line 263)

Get the value for this element's username attribute.

- return: The attribute being modified.
- see: Zend_Gdata_Gapps_Extension_Login::setUsername()
- access: public

string getUsername ()
setAdmin (line 359)

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

- return: Provides a fluent interface.
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

Zend_Gdata_Gapps_Extension_Login setAdmin (boolean $value)

- boolean $value: The desired value for this attribute.

setAgreedToTerms (line 393)

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

- return: Provides a fluent interface.
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

Zend_Gdata_Gapps_Extension_Login setAgreedToTerms (boolean $value)

- boolean $value: The desired value for this attribute.

setChangePasswordAtNextLogin (line 462)

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.

- return: Provides a fluent interface.
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

Zend_Gdata_Gapps_Extension_Login setChangePasswordAtNextLogin (boolean $value)

- boolean $value: The desired value for this attribute.

setHashFunctionName (line 329)

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'.

- return: Provides a fluent interface.
- access: public

Zend_Gdata_Gapps_Extension_Login setHashFunctionName (string $value)

- string $value: The desired value for this attribute.

setPassword (line 302)

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().

- return: Provides a fluent interface.
- access: public

Zend_Gdata_Gapps_Extension_Login setPassword (string $value)

- string $value: The desired value for this attribute.

setSuspended (line 427)

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

- return: Provides a fluent interface.
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

Zend_Gdata_Gapps_Extension_Login setSuspended (boolean $value)

- boolean $value: The desired value for this attribute.

setUsername (line 276)

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.

- return: Provides a fluent interface.
- access: public

Zend_Gdata_Gapps_Extension_Login setUsername (string $value)

- string $value: The desired value for this attribute.

takeAttributeFromDOM (line 192)

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.

- throws: Zend_Gdata_App_InvalidArgumentException
- access: protected

void takeAttributeFromDOM (DOMNode $attribute)

- DOMNode $attribute: The DOMNode attribute needed to be handled

Redefinition of:

Zend_Gdata_App_Base::takeAttributeFromDOM()
  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.

__toString (line 476)

Magic toString method allows using this directly via echo

Works best in PHP >= 4.2.0

- access: public

void __toString ()

Redefinition of:

Zend_Gdata_App_Base::__toString()
  Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

#### Inherited Methods

Inherited From Zend_Gdata_Extension

> Zend_Gdata_Extension::__construct()

Inherited From Zend_Gdata_App_Base

> Zend_Gdata_App_Base::__construct()
> Zend_Gdata_App_Base::encode()
> Zend_Gdata_App_Base::flushNamespaceLookupCache()
> Zend_Gdata_App_Base::getDOM()
> Zend_Gdata_App_Base::getExtensionAttributes()
> Zend_Gdata_App_Base::getExtensionElements()
> Zend_Gdata_App_Base::getText()
> Zend_Gdata_App_Base::getXML()
> Zend_Gdata_App_Base::lookupNamespace()
> Zend_Gdata_App_Base::registerAllNamespaces()
> Zend_Gdata_App_Base::registerNamespace()
> Zend_Gdata_App_Base::saveXML()
> Zend_Gdata_App_Base::setExtensionAttributes()
> Zend_Gdata_App_Base::setExtensionElements()
> Zend_Gdata_App_Base::setText()
> Zend_Gdata_App_Base::takeAttributeFromDOM()
> Zend_Gdata_App_Base::takeChildFromDOM()
> Zend_Gdata_App_Base::transferFromDOM()
> Zend_Gdata_App_Base::transferFromXML()
> Zend_Gdata_App_Base::__get()
> Zend_Gdata_App_Base::__isset()
> Zend_Gdata_App_Base::__set()
> Zend_Gdata_App_Base::__toString()
> Zend_Gdata_App_Base::__unset()

Documentation generated on Tue, 26 Oct 2010 20:08:55 +0400 by phpDocumentor 1.4.2