Class Zend_Gdata_Gapps_EmailListEntry

Description

Data model class for a Google Apps Email List Entry.

Each email list entry describes a single email list within a Google Apps hosted domain. Email lists may contain multiple recipients, as described by instances of Zend_Gdata_Gapps_EmailListRecipient. Multiple entries are contained within instances of Zend_Gdata_Gapps_EmailListFeed.

To transfer email list 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/EmailListEntry.php (line 59)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_FeedEntryParent
      |
      --Zend_Gdata_App_Entry
         |
         --Zend_Gdata_App_MediaEntry
            |
            --Zend_Gdata_Entry
               |
               --Zend_Gdata_Gapps_EmailListEntry
Variable Summary
Method Summary
 Zend_Gdata_Gapps_EmailListEntry __construct ([DOMElement $element = null])
 DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
 mixed getFeedLink ([string $rel = null])
 Zend_Gdata_Gapps_EventEntry setEmailList (Zend_Gdata_Gapps_Extension_EmailList $value)
 Zend_Gdata_Gapps_EventEntry setFeedLink (array $value)
 void takeChildFromDOM (DOMNode $child)
Variables
Zend_Gdata_Gapps_Extension_EmailList $_emailList = null (line 70)

<apps:emailList> child element containing general information about this email list.

  • access: protected
mixed $_entryClassName = 'Zend_Gdata_Gapps_EmailListEntry' (line 62)
  • access: protected

Redefinition of:
Zend_Gdata_Entry::$_entryClassName
Zend_Gdata_Extension_FeedLink $_feedLink = array() (line 78)

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

  • 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 86)

Create a new instance.

  • access: public
Zend_Gdata_Gapps_EmailListEntry __construct ([DOMElement $element = null])
  • DOMElement $element: (optional) DOMElement from which this object should be constructed.

Redefinition of:
Zend_Gdata_Entry::__construct()
getDOM (line 101)

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()
getEmailList (line 147)

Retrieve the email list property for this entry.

getFeedLink (line 182)

Get the feed link property for this entry.

  • return: If $rel is specified, a Zend_Gdata_Extension_FeedLink object corresponding to the requested rel value is returned if found, or null if the requested value is not found. If $rel is null or not specified, an array of all available feed links for this entry is returned, or null if no feed links are set.
  • see: Zend_Gdata_Gapps_EmailListEntry::setFeedLink()
  • access: public
mixed getFeedLink ([string $rel = null])
  • string $rel: (optional) The rel value of the link to be found. If null, the array of links is returned.
setEmailList (line 163)

Set the email list property for this entry. This property contains information such as the name of this email list.

This corresponds to the <apps:emailList> property in the Google Data protocol.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Gapps_EventEntry setEmailList (Zend_Gdata_Gapps_Extension_EmailList $value)
setFeedLink (line 208)

Set the feed link property for this entry. Feed links provide information about other feeds associated with this entry.

This corresponds to the <gd:feedLink> property in the Google Data protocol.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Gapps_EventEntry setFeedLink (array $value)
  • array $value: A collection of Zend_Gdata_Gapps_Extension_FeedLink instances representing all feed links for this entry, or null to unset.
takeChildFromDOM (line 119)

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 Mon, 21 Jun 2010 15:18:58 -0400 by phpDocumentor 1.4.3