Gdata/Gapps/Extension/Login.php
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Gapps
- Version
- $Id$
\Zend_Gdata_Gapps_Extension_Login
- Parent(s)
- \Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
boolean $_admin = null
null
Details- Type
- boolean
\boolean. $_agreedToTerms = null
null
Details- Type
- \boolean.
boolean $_changePasswordAtNextLogin = null
null
Details- Type
- boolean
string $_hashFunctionName = null
null
Details- Type
- string
string $_password = null
null
Details- Type
- string
boolean $_suspended = null
null
Details- Type
- boolean
Methods
__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
|
$password | string | (optional) The password to be used for this
|
$hashFunctionName | string | (optional) The name of the hash
|
$admin | boolean | (optional) Whether the user is an administrator
|
$suspended | boolean | (optional) Whether this login is suspended or not. |
$changePasswordAtNextLogin | boolean | (optional) Whether
|
$agreedToTerms | boolean | (optional) Whether the user has
|
__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. |
getSuspended() : boolean
Get the value for this element's suspended attribute.
Type | Description |
---|---|
boolean | The requested attribute. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |
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.
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 |