Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
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.

boolean
$_admin= 'null'
True if the user has administrative rights for this domain, false otherwise.
null
Details
\boolean.
$_agreedToTerms= 'null'
True if the user has agreed to the terms of service for Google Apps, false otherwise.
null
Details
boolean
$_changePasswordAtNextLogin= 'null'
True if the user will be required to change their password at their next login, false otherwise.
null
Details
string
$_hashFunctionName= 'null'
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
null
Details
string
$_password= 'null'
The password for the user. May be in cleartext or as an SHA-1 digest, depending on the value of _hashFunctionName.
null
Details
boolean
$_suspended= 'null'
True if this user has been suspended, false otherwise.
null
Details
__construct(
string $username
=
null, string $password
=
null, string $hashFunctionName
=
null, boolean $admin
=
null, boolean $suspended
=
null, boolean $changePasswordAtNextLogin
=
null, boolean $agreedToTerms
=
null
)
:
void
Constructs a new Zend_Gdata_Gapps_Extension_Login object.
Name | Type | Description |
---|---|---|
$username | string | (optional) The username to be used for this login. |
$password | string | (optional) The password to be used for this login. |
$hashFunctionName | string | (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. |
$admin | boolean | (optional) Whether the user is an administrator or not. |
$suspended | boolean | (optional) Whether this login is suspended or not. |
$changePasswordAtNextLogin | boolean | (optional) Whether the user is required to change their password at their next login. |
$agreedToTerms | boolean | (optional) Whether the user has agreed to the terms of service. |

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

getAdmin(
)
:
boolean
Get the value for this element's admin attribute.
Type | Description |
---|---|
boolean | The requested attribute. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

getAgreedToTerms(
)
:
boolean
Get the value for this element's agreedToTerms attribute.
Type | Description |
---|---|
boolean | The requested attribute. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

getChangePasswordAtNextLogin(
)
:
boolean
Get the value for this element's changePasswordAtNextLogin attribute.
Type | Description |
---|---|
boolean | The requested attribute. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

getDOM(
\DOMDocument $doc
=
null, $majorVersion
=
1, $minorVersion
=
null
)
:
\DOMElement
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.
Name | Type | Description |
---|---|---|
$doc | \DOMDocument | The DOMDocument used to construct DOMElements |
$majorVersion | ||
$minorVersion |
Type | Description |
---|---|
\DOMElement | The DOMElement representing this element and all child properties. |

getHashFunctionName(
)
:
string
Get the value for this element's hashFunctionName attribute.
Type | Description |
---|---|
string | The requested attribute. |

getPassword(
)
:
string
Get the value for this element's password attribute.
Type | Description |
---|---|
string | The requested attribute. |

getSuspended(
)
:
boolean
Get the value for this element's suspended attribute.
Type | Description |
---|---|
boolean | The requested attribute. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

getUsername(
)
:
string
Get the value for this element's username attribute.
Type | Description |
---|---|
string | The attribute being modified. |

setAdmin(
boolean $value
)
:
\Zend_Gdata_Gapps_Extension_Login
Set the value for this element's admin attribute. This indicates whether this user is an administrator for this domain.
Name | Type | Description |
---|---|---|
$value | boolean | The desired value for this attribute. |
Type | Description |
---|---|
\Zend_Gdata_Gapps_Extension_Login | Provides a fluent interface. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

setAgreedToTerms(
boolean $value
)
:
\Zend_Gdata_Gapps_Extension_Login
Set the value for this element's agreedToTerms attribute. This indicates whether this user has agreed to the terms of service.
Name | Type | Description |
---|---|---|
$value | boolean | The desired value for this attribute. |
Type | Description |
---|---|
\Zend_Gdata_Gapps_Extension_Login | Provides a fluent interface. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

setChangePasswordAtNextLogin(
boolean $value
)
:
\Zend_Gdata_Gapps_Extension_Login
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.
Name | Type | Description |
---|---|---|
$value | boolean | The desired value for this attribute. |
Type | Description |
---|---|
\Zend_Gdata_Gapps_Extension_Login | Provides a fluent interface. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

setHashFunctionName(
string $value
)
:
\Zend_Gdata_Gapps_Extension_Login
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'.
Name | Type | Description |
---|---|---|
$value | string | The desired value for this attribute. |
Type | Description |
---|---|
\Zend_Gdata_Gapps_Extension_Login | Provides a fluent interface. |

setPassword(
string $value
)
:
\Zend_Gdata_Gapps_Extension_Login
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().
Name | Type | Description |
---|---|---|
$value | string | The desired value for this attribute. |
Type | Description |
---|---|
\Zend_Gdata_Gapps_Extension_Login | Provides a fluent interface. |

setSuspended(
boolean $value
)
:
\Zend_Gdata_Gapps_Extension_Login
Set the value for this element's suspended attribute. If true, the user will not be able to login to this domain until unsuspended.
Name | Type | Description |
---|---|---|
$value | boolean | The desired value for this attribute. |
Type | Description |
---|---|
\Zend_Gdata_Gapps_Extension_Login | Provides a fluent interface. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

setUsername(
string $value
)
:
\Zend_Gdata_Gapps_Extension_Login
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.
Name | Type | Description |
---|---|---|
$value | string | The desired value for this attribute. |
Type | Description |
---|---|
\Zend_Gdata_Gapps_Extension_Login | Provides a fluent interface. |

takeAttributeFromDOM(
\DOMNode $attribute
)
:
void
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.
Name | Type | Description |
---|---|---|
$attribute | \DOMNode | The DOMNode attribute needed to be handled |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |