## Zend_Gdata_Gapps_UserEntry

Description

Data model class for a Google Apps User Entry.

Each user entry describes a single user within a Google Apps hosted domain.

To transfer user entries to and from the Google Apps servers, including creating new entries, refer to the Google Apps service class, Zend_Gdata_Gapps.

This class represents <atom:entry> in the Google Data protocol.

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

Located in /Gdata/Gapps/UserEntry.php (line 67)

    Zend_Gdata_App_Base
       |
       --Zend_Gdata_App_FeedEntryParent
          |
          --Zend_Gdata_App_Entry
             |
             --Zend_Gdata_App_MediaEntry
                |
                --Zend_Gdata_Entry
                   |
                   --Zend_Gdata_Gapps_UserEntry

Variable Summary
mixed $_entryClassName
Zend_Gdata_Extension_FeedLink $_feedLink
Zend_Gdata_Gapps_Extension_Login $_login
Zend_Gdata_Gapps_Extension_Name $_name
Zend_Gdata_Gapps_Extension_Quota $_quota
Method Summary
Zend_Gdata_Gapps_UserEntry __construct ([DOMElement $element = null])
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
mixed getFeedLink ([string $rel = null])
Zend_Gdata_Gapps_Extension_Login getLogin ()
Zend_Gdata_Gapps_Extension_Name getName ()
Zend_Gdata_Gapps_Extension_Quota getQuota ()
Zend_Gdata_Gapps_EventEntry setFeedLink (array $value)
Zend_Gdata_Gapps_UserEntry setLogin (Zend_Gdata_Gapps_Extension_Login $value)
Zend_Gdata_Gapps_UserEntry setName (Zend_Gdata_Gapps_Extension_Name $value)
Zend_Gdata_Gapps_UserEntry setQuota (Zend_Gdata_Gapps_Extension_Quota $value)
void takeChildFromDOM (DOMNode $child)
Variables
mixed $_entryClassName = 'Zend_Gdata_Gapps_UserEntry' (line 70)

- access: protected

Redefinition of:

Zend_Gdata_Entry::$_entryClassName

Zend_Gdata_Extension_FeedLink $_feedLink = array() (line 101)

<gd:feedLink> element containing information about other feeds relevant to this entry.

- access: protected

Zend_Gdata_Gapps_Extension_Login $_login = null (line 78)

<apps:login> element containing information about this user's account, including their username and permissions.

- access: protected

Zend_Gdata_Gapps_Extension_Name $_name = null (line 85)

<apps:name> element containing the user's actual name.

- access: protected

Zend_Gdata_Gapps_Extension_Quota $_quota = null (line 93)

<apps:quotq> element describing any storage quotas in place for this user.

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_App_MediaEntry

> Zend_Gdata_App_MediaEntry::$_mediaSource

Inherited from Zend_Gdata_App_Entry

> Zend_Gdata_App_Entry::$_content
> Zend_Gdata_App_Entry::$_control
> Zend_Gdata_App_Entry::$_edited
> Zend_Gdata_App_Entry::$_published
> Zend_Gdata_App_Entry::$_rootElement
> Zend_Gdata_App_Entry::$_source
> Zend_Gdata_App_Entry::$_summary

Inherited from Zend_Gdata_App_FeedEntryParent

> Zend_Gdata_App_FeedEntryParent::$_author
> Zend_Gdata_App_FeedEntryParent::$_category
> Zend_Gdata_App_FeedEntryParent::$_contributor
> Zend_Gdata_App_FeedEntryParent::$_etag
> Zend_Gdata_App_FeedEntryParent::$_id
> Zend_Gdata_App_FeedEntryParent::$_link
> Zend_Gdata_App_FeedEntryParent::$_majorProtocolVersion
> Zend_Gdata_App_FeedEntryParent::$_minorProtocolVersion
> Zend_Gdata_App_FeedEntryParent::$_rights
> Zend_Gdata_App_FeedEntryParent::$_service
> Zend_Gdata_App_FeedEntryParent::$_title
> Zend_Gdata_App_FeedEntryParent::$_updated

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::$_rootNamespace
> Zend_Gdata_App_Base::$_rootNamespaceURI
> Zend_Gdata_App_Base::$_text

Methods
Constructor __construct (line 109)

Create a new instance.

- access: public

Zend_Gdata_Gapps_UserEntry __construct ([DOMElement $element = null])

- DOMElement $element: (optional) DOMElement from which this object should be constructed.

Redefinition of:

Zend_Gdata_Entry::__construct()

getDOM (line 124)

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

getFeedLink (line 267)

Returns all feed links for this entry, or if a rel value is specified, the feed link associated with that value is returned.

- return: Either an array of Zend_Gdata_Extension_FeedLink objects if $rel is null, a single Zend_Gdata_Extension_FeedLink object if $rel is specified and a matching feed link is found, or null if $rel is specified and no matching feed link is found.
- access: public

mixed getFeedLink ([string $rel = null])

- string $rel: The rel value of the link to be found. If null, the array of links is returned instead.

getLogin (line 185)

Get the value of the login property for this object.

- return: The requested object.
- see: Zend_Gdata_Gapps_UserEntry::setLogin()
- access: public

Zend_Gdata_Gapps_Extension_Login getLogin ()
getName (line 210)

Get the value of the name property for this object.

- return: The requested object.
- see: Zend_Gdata_Gapps_UserEntry::setName()
- access: public

Zend_Gdata_Gapps_Extension_Name getName ()
getQuota (line 235)

Get the value of the quota property for this object.

- return: The requested object.
- see: Zend_Gdata_Gapps_UserEntry::setQuota()
- access: public

Zend_Gdata_Gapps_Extension_Quota getQuota ()
setFeedLink (line 289)

Set the value of the feed link property for this object. This property is used to provide links to alternative feeds relevant to this entry.

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

Zend_Gdata_Gapps_EventEntry setFeedLink (array $value)

- array $value: A collection of Zend_Gdata_Gapps_Extension_FeedLink objects.

setLogin (line 198)

Set the value of the login property for this object. This property is used to store the username address of the current user.

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

Zend_Gdata_Gapps_UserEntry setLogin (Zend_Gdata_Gapps_Extension_Login $value)

- Zend_Gdata_Gapps_Extension_Login $value: The desired value for this instance's login property.

setName (line 223)

Set the value of the name property for this object. This property is used to store the full name of the current user.

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

Zend_Gdata_Gapps_UserEntry setName (Zend_Gdata_Gapps_Extension_Name $value)

- Zend_Gdata_Gapps_Extension_Name $value: The desired value for this instance's name property.

setQuota (line 249)

Set the value of the quota property for this object. This property is used to store the amount of storage available for the current user. Quotas may not be modifiable depending on the domain used.

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

Zend_Gdata_Gapps_UserEntry setQuota (Zend_Gdata_Gapps_Extension_Quota $value)

- Zend_Gdata_Gapps_Extension_Quota $value: The desired value for this instance's quota property.

takeChildFromDOM (line 148)

Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

- access: protected

void takeChildFromDOM (DOMNode $child)

- DOMNode $child: The DOMNode to process

Redefinition of:

Zend_Gdata_Entry::takeChildFromDOM()

#### Inherited Methods

Inherited From Zend_Gdata_Entry

> Zend_Gdata_Entry::__construct()
> Zend_Gdata_Entry::getDOM()
> Zend_Gdata_Entry::takeAttributeFromDOM()
> Zend_Gdata_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_MediaEntry

> Zend_Gdata_App_MediaEntry::__construct()
> Zend_Gdata_App_MediaEntry::encode()
> Zend_Gdata_App_MediaEntry::getMediaSource()
> Zend_Gdata_App_MediaEntry::setMediaSource()

Inherited From Zend_Gdata_App_Entry

> Zend_Gdata_App_Entry::delete()
> Zend_Gdata_App_Entry::getContent()
> Zend_Gdata_App_Entry::getControl()
> Zend_Gdata_App_Entry::getDOM()
> Zend_Gdata_App_Entry::getPublished()
> Zend_Gdata_App_Entry::getSource()
> Zend_Gdata_App_Entry::getSummary()
> Zend_Gdata_App_Entry::reload()
> Zend_Gdata_App_Entry::save()
> Zend_Gdata_App_Entry::setContent()
> Zend_Gdata_App_Entry::setControl()
> Zend_Gdata_App_Entry::setPublished()
> Zend_Gdata_App_Entry::setSource()
> Zend_Gdata_App_Entry::setSummary()
> Zend_Gdata_App_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_FeedEntryParent

> Zend_Gdata_App_FeedEntryParent::__construct()
> Zend_Gdata_App_FeedEntryParent::getAlternateLink()
> Zend_Gdata_App_FeedEntryParent::getAuthor()
> Zend_Gdata_App_FeedEntryParent::getCategory()
> Zend_Gdata_App_FeedEntryParent::getContributor()
> Zend_Gdata_App_FeedEntryParent::getDOM()
> Zend_Gdata_App_FeedEntryParent::getEditLink()
> Zend_Gdata_App_FeedEntryParent::getEtag()
> Zend_Gdata_App_FeedEntryParent::getHttpClient()
> Zend_Gdata_App_FeedEntryParent::getId()
> Zend_Gdata_App_FeedEntryParent::getLicenseLink()
> Zend_Gdata_App_FeedEntryParent::getLink()
> Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::getNextLink()
> Zend_Gdata_App_FeedEntryParent::getPreviousLink()
> Zend_Gdata_App_FeedEntryParent::getRights()
> Zend_Gdata_App_FeedEntryParent::getSelfLink()
> Zend_Gdata_App_FeedEntryParent::getService()
> Zend_Gdata_App_FeedEntryParent::getTitle()
> Zend_Gdata_App_FeedEntryParent::getTitleValue()
> Zend_Gdata_App_FeedEntryParent::getUpdated()
> Zend_Gdata_App_FeedEntryParent::lookupNamespace()
> Zend_Gdata_App_FeedEntryParent::setAuthor()
> Zend_Gdata_App_FeedEntryParent::setCategory()
> Zend_Gdata_App_FeedEntryParent::setContributor()
> Zend_Gdata_App_FeedEntryParent::setEtag()
> Zend_Gdata_App_FeedEntryParent::setHttpClient()
> Zend_Gdata_App_FeedEntryParent::setId()
> Zend_Gdata_App_FeedEntryParent::setLink()
> Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::setMinorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::setRights()
> Zend_Gdata_App_FeedEntryParent::setService()
> Zend_Gdata_App_FeedEntryParent::setTitle()
> Zend_Gdata_App_FeedEntryParent::setUpdated()
> Zend_Gdata_App_FeedEntryParent::takeChildFromDOM()

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:09:19 +0400 by phpDocumentor 1.4.2