Gdata/Gapps/Extension/Login.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Gapps
- Version
- $Id: Login.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_Gapps_Extension_Login
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.
- Parent(s)
- \Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 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


array $_extensionAttributes = array()
Leftover attributes which were not handled
array()
Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_extensionAttributes
- Inherited_from
- \Zend_Gdata_App_Extension::$$_extensionAttributes
- Inherited_from
- \Zend_Gdata_Extension::$$_extensionAttributes


array $_extensionElements = array()
Leftover elements which were not handled
array()
Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_extensionElements
- Inherited_from
- \Zend_Gdata_App_Extension::$$_extensionElements
- Inherited_from
- \Zend_Gdata_Extension::$$_extensionElements


string $_hashFunctionName = null
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- Type
- string


array $_namespaceLookupCache = array()
Memoized results from calls to lookupNamespace() to avoid expensive calls to getGreatestBoundedValue(). The key is in the form 'prefix-majorVersion-minorVersion', and the value is the output from getGreatestBoundedValue().
array()
Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_namespaceLookupCache
- Inherited_from
- \Zend_Gdata_App_Extension::$$_namespaceLookupCache
- Inherited_from
- \Zend_Gdata_Extension::$$_namespaceLookupCache


array $_namespaces = array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))
The first dimension represents the namespace prefix, the second dimension represents the minimum major protocol version, and the third dimension is the minimum minor protocol version. Null keys are NOT allowed.
When looking up a namespace for a given prefix, the greatest version number (both major and minor) which is less than the effective version should be used.
array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))
Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_namespaces
- Inherited_from
- \Zend_Gdata_App_Extension::$$_namespaces
- Inherited_from
- \Zend_Gdata_Extension::$$_namespaces
- See
- \lookupNamespace()
- See
- \registerNamespace()
- See
- \registerAllNamespaces()


string $_password = null
May be in cleartext or as an SHA-1 digest, depending on the value of _hashFunctionName.
null
Details- Type
- string


string $_rootElement = 'login'
The XML element name, including prefix if desired
'login'
Details- Type
- string


string $_rootNamespaceURI = null
The XML namespace URI - takes precedence over lookup up the corresponding URI for $_rootNamespace
null
Details- Type
- string
- Inherited_from
- \Zend_Gdata_App_Base::$$_rootNamespaceURI
- Inherited_from
- \Zend_Gdata_App_Extension::$$_rootNamespaceURI
- Inherited_from
- \Zend_Gdata_Extension::$$_rootNamespaceURI


boolean $_suspended = null
null
Details- Type
- boolean


string $_text = null
XML child text node content
null
Details- Type
- string
- Inherited_from
- \Zend_Gdata_App_Base::$$_text
- Inherited_from
- \Zend_Gdata_App_Extension::$$_text
- Inherited_from
- \Zend_Gdata_Extension::$$_text
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 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. |


__get(string $name) : void
Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.
Inherited from: \Zend_Gdata_App_Base::__get()\Zend_Gdata_App_Extension::__get()\Zend_Gdata_Extension::__get()TODO Remove ability to bypass getFoo() methods??
Name | Type | Description |
---|---|---|
$name | string | The variable name sought |


__isset(string $name) : void
Magic __isset method
Inherited from: \Zend_Gdata_App_Base::__isset()\Zend_Gdata_App_Extension::__isset()\Zend_Gdata_Extension::__isset()Name | Type | Description |
---|---|---|
$name | string |


__set(string $name, $val) : void
Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.
Inherited from: \Zend_Gdata_App_Base::__set()\Zend_Gdata_App_Extension::__set()\Zend_Gdata_Extension::__set()Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.
TODO Remove ability to bypass getFoo() methods??
Name | Type | Description |
---|---|---|
$name | string | |
$val |


__toString() : string
Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0
Type | Description |
---|---|
string | The text representation of this object |


__unset(string $name) : void
Magic __unset method
Inherited from: \Zend_Gdata_App_Base::__unset()\Zend_Gdata_App_Extension::__unset()\Zend_Gdata_Extension::__unset()Name | Type | Description |
---|---|---|
$name | string |


encode() : string
Alias for saveXML()
Inherited from: \Zend_Gdata_App_Base::encode()\Zend_Gdata_App_Extension::encode()\Zend_Gdata_Extension::encode()Can be overridden by children to provide more complex representations of entries.
Type | Description |
---|---|
string | Encoded string content |


flushNamespaceLookupCache() : void
Flush namespace lookup cache.
Inherited from: \Zend_Gdata_App_Base::flushNamespaceLookupCache()\Zend_Gdata_App_Extension::flushNamespaceLookupCache()\Zend_Gdata_Extension::flushNamespaceLookupCache()Empties the namespace lookup cache. Call this function if you have added data to the namespace lookup table that contradicts values that may have been cached during a previous call to lookupNamespace().


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


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


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


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


getExtensionAttributes() : array
Returns an array of all extension attributes not transformed into data model properties during parsing of the XML.
Inherited from: \Zend_Gdata_App_Base::getExtensionAttributes()\Zend_Gdata_App_Extension::getExtensionAttributes()\Zend_Gdata_Extension::getExtensionAttributes()Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);
Type | Description |
---|---|
array | All extension attributes |


getExtensionElements() : array
Returns an array of all elements not matched to data model classes during the parsing of the XML
Inherited from: \Zend_Gdata_App_Base::getExtensionElements()\Zend_Gdata_App_Extension::getExtensionElements()\Zend_Gdata_Extension::getExtensionElements()Type | Description |
---|---|
array | All elements not matched to data model classes during parsing |


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


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


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


getText( $trim = true) : string
Returns the child text node of this element This represents any raw text contained within the XML element
Inherited from: \Zend_Gdata_App_Base::getText()\Zend_Gdata_App_Extension::getText()\Zend_Gdata_Extension::getText()Name | Type | Description |
---|---|---|
$trim |
Type | Description |
---|---|
string | Child text node |


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


getXML() : string
Alias for saveXML() returns XML content for this element and all children
Inherited from: \Zend_Gdata_App_Base::getXML()\Zend_Gdata_App_Extension::getXML()\Zend_Gdata_Extension::getXML()Type | Description |
---|---|
string | XML content |


lookupNamespace(string $prefix, integer $majorVersion = 1, integer $minorVersion = null) : string
Get the full version of a namespace prefix
Inherited from: \Zend_Gdata_App_Base::lookupNamespace()\Zend_Gdata_App_Extension::lookupNamespace()\Zend_Gdata_Extension::lookupNamespace()Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.
Name | Type | Description |
---|---|---|
$prefix | string | The namespace prefix to lookup. |
$majorVersion | integer | The major protocol version in effect. Defaults to '1'. |
$minorVersion | integer | The minor protocol version in effect. Defaults to null (use latest). |
Type | Description |
---|---|
string |


registerAllNamespaces(array $namespaceArray) : void
Add an array of namespaces to the registered list.
Inherited from: \Zend_Gdata_App_Base::registerAllNamespaces()\Zend_Gdata_App_Extension::registerAllNamespaces()\Zend_Gdata_Extension::registerAllNamespaces()Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()
Name | Type | Description |
---|---|---|
$namespaceArray | array | An array of namespaces. |


registerNamespace(string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0) : void
Add a namespace and prefix to the registered list
Inherited from: \Zend_Gdata_App_Base::registerNamespace()\Zend_Gdata_App_Extension::registerNamespace()\Zend_Gdata_Extension::registerNamespace()Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().
WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().
Name | Type | Description |
---|---|---|
$prefix | string | The namespace prefix |
$namespaceUri | string | The full namespace URI |
$majorVersion | integer | The major protocol version in effect. Defaults to '1'. |
$minorVersion | integer | The minor protocol version in effect. Defaults to null (use latest). |


saveXML() : string
Converts this element and all children into XML text using getDOM()
Inherited from: \Zend_Gdata_App_Base::saveXML()\Zend_Gdata_App_Extension::saveXML()\Zend_Gdata_Extension::saveXML()Type | Description |
---|---|
string | XML content |


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 |


setExtensionAttributes(array $value) : \Zend_Gdata_App_Base
Sets an array of all extension attributes not transformed into data model properties during parsing of the XML.
Inherited from: \Zend_Gdata_App_Base::setExtensionAttributes()\Zend_Gdata_App_Extension::setExtensionAttributes()\Zend_Gdata_Extension::setExtensionAttributes()Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string); This can be used to add arbitrary attributes to any data model element
Name | Type | Description |
---|---|---|
$value | array | All extension attributes |
Type | Description |
---|---|
\Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |


setExtensionElements(array $value) : \Zend_Gdata_App_Base
Sets an array of all elements not matched to data model classes during the parsing of the XML.
Inherited from: \Zend_Gdata_App_Base::setExtensionElements()\Zend_Gdata_App_Extension::setExtensionElements()\Zend_Gdata_Extension::setExtensionElements()This method can be used to add arbitrary child XML elements to any data model class.
Name | Type | Description |
---|---|---|
$value | array | All extension elements |
Type | Description |
---|---|
\Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |


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 |


setText(string $value) : \Zend_Gdata_App_Base
Sets the child text node of this element This represents any raw text contained within the XML element
Inherited from: \Zend_Gdata_App_Base::setText()\Zend_Gdata_App_Extension::setText()\Zend_Gdata_Extension::setText()Name | Type | Description |
---|---|---|
$value | string | Child text node |
Type | Description |
---|---|
\Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |


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 |


takeChildFromDOM(\DOMNode $child) : void
Given a child DOMNode, tries to determine how to map the data into object instance members.
Inherited from: \Zend_Gdata_App_Base::takeChildFromDOM()\Zend_Gdata_App_Extension::takeChildFromDOM()\Zend_Gdata_Extension::takeChildFromDOM()If no mapping is defined, Extension_Element objects are created and stored in an array.
Name | Type | Description |
---|---|---|
$child | \DOMNode | The DOMNode needed to be handled |


transferFromDOM(\DOMNode $node) : void
Transfers each child and attribute into member variables.
Inherited from: \Zend_Gdata_App_Base::transferFromDOM()\Zend_Gdata_App_Extension::transferFromDOM()\Zend_Gdata_Extension::transferFromDOM()This is called when XML is received over the wire and the data model needs to be built to represent this XML.
Name | Type | Description |
---|---|---|
$node | \DOMNode | The DOMNode that represents this object's data |


transferFromXML(string $xml) : void
Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element).
Inherited from: \Zend_Gdata_App_Base::transferFromXML()\Zend_Gdata_App_Extension::transferFromXML()\Zend_Gdata_Extension::transferFromXML()The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.
Name | Type | Description |
---|---|---|
$xml | string | The XML text to parse |