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 in the Google Data protocol.

category Zend
package Zend_Gdata
subpackage Gapps
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Gdata_Entry

 Methods

Create a new instance.

__construct(\DOMElement $element = null
inherited_from \Zend_Gdata_Entry::__construct()

Parameters

$element

\DOMElement

(optional) DOMElement from which this object should be constructed.

__construct()

__construct() 
Inherited

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.

__get(string $name) 
Inherited

TODO Remove ability to bypass getFoo() methods??

Parameters

$name

string

The variable name sought

Magic __isset method

__isset(string $name) 
Inherited

Parameters

$name

string

Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.

__set(string $name, $val) 
Inherited

Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.

TODO Remove ability to bypass getFoo() methods??

Parameters

$name

string

$val

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

__toString() : string
Inherited

Returns

stringThe text representation of this object

Magic __unset method

__unset(string $name) 
Inherited

Parameters

$name

string

Deletes this entry to the server using the referenced Zend_Http_Client to do a HTTP DELETE to the edit link stored in this entry's link collection.

delete() : void
Inherited

Exceptions

\Zend_Gdata_App_Exception

Alias for saveXML()

encode() : string
Inherited

Can be overridden by children to provide more complex representations of entries.

Returns

stringEncoded string content

Flush namespace lookup cache.

flushNamespaceLookupCache() 
InheritedStatic

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

getAuthor()

getAuthor() : \Zend_Gdata_App_Extension_Author
Inherited

Returns

\Zend_Gdata_App_Extension_Author

Returns the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

getCategory() : array
Inherited

Returns

arrayArray of Zend_Gdata_App_Extension_Category

Gets the value of the atom:content element

getContent() : \Zend_Gdata_App_Extension_Content
Inherited

Returns

\Zend_Gdata_App_Extension_Content

Returns the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

getContributor() : array
Inherited

Returns

arrayAn array of Zend_Gdata_App_Extension_Contributor

Gets the value of the app:control element

getControl() : \Zend_Gdata_App_Extension_Control
Inherited

Returns

\Zend_Gdata_App_Extension_Control

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.

getDOM(\DOMDocument $doc = null, $majorVersion = 1, $minorVersion = null) : \DOMElement
inherited_from \Zend_Gdata_Entry::getDOM()

Parameters

$doc

\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion

$minorVersion

Returns

\DOMElementThe DOMElement representing this element and all child properties.

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.

getDOM(\DOMDocument $doc = null, $majorVersion = 1, $minorVersion = null) : \DOMElement
Inherited

Parameters

$doc

\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion

$minorVersion

Returns

\DOMElementThe DOMElement representing this element and all child properties.

Retrieve the email list property for this entry.

getEmailList() : \Zend_Gdata_Gapps_Extension_EmailList
see

Returns

\Zend_Gdata_Gapps_Extension_EmailListThe requested object or null if not set.

Return the Etag for the current entry, or null if not set.

getEtag() : string | null
Inherited

Returns

stringnull

Returns an array of all extension attributes not transformed into data model properties during parsing of the XML. Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);

getExtensionAttributes() : array
Inherited

Returns

arrayAll extension attributes

Returns an array of all elements not matched to data model classes during the parsing of the XML

getExtensionElements() : array
Inherited

Returns

arrayAll elements not matched to data model classes during parsing

Gets the HTTP client object. If none is set, a new Zend_Http_Client will be used.

getHttpClient() : \Zend_Http_Client_Abstract
Inherited
deprecated Deprecated as of Zend Framework 1.7. Use getService() instead.

Returns

\Zend_Http_Client_Abstract

getId()

getId() : \Zend_Gdata_App_Extension_Id
Inherited

Returns

\Zend_Gdata_App_Extension_Id

Get the major protocol version that is in use.

getMajorProtocolVersion() : \(int | \NULL)
Inherited
see

Returns

\(int\NULL)The major protocol version in use.

Return the MediaSource object representing the file attached to this MediaEntry.

getMediaSource() : \Zend_Gdata_App_MediaSource
Inherited

Returns

\Zend_Gdata_App_MediaSourceThe attached MediaSource/file

Get the minor protocol version that is in use.

getMinorProtocolVersion() : \(int | \NULL)
Inherited
see

Returns

\(int\NULL)The major protocol version in use, or NULL if no minor version is specified.

Sets the value of the atom:published element This represents the publishing date for an entry

getPublished() : \Zend_Gdata_App_Extension_Published
Inherited

Returns

\Zend_Gdata_App_Extension_Published

getRights()

getRights() : \Zend_Gdata_AppExtension_Rights
Inherited

Returns

\Zend_Gdata_AppExtension_Rights

Get the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

getService() : \Zend_Gdata_App | null
Inherited

Returns

\Zend_Gdata_AppnullThe current service instance, or null if not set.

Gets the value of the atom:source element

getSource() : \Zend_Gdata_App_Extension_Source
Inherited

Returns

\Zend_Gdata_App_Extension_Source

Gets the value of the atom:summary element This represents a textual summary of this entry's content

getSummary() : \Zend_Gdata_App_Extension_Summary
Inherited

Returns

\Zend_Gdata_App_Extension_Summary

Returns the child text node of this element This represents any raw text contained within the XML element

getText($trim = true) : string
Inherited

Parameters

$trim

Returns

stringChild text node

Returns the title of this feed or entry. The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

getTitle() : \Zend_Gdata_App_Extension_Title
Inherited

Returns

\Zend_Gdata_App_Extension_Title

Returns a string representation of the title of this feed or entry.

getTitleValue() : string
Inherited

The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Returns

string

getUpdated()

getUpdated() : \Zend_Gdata_App_Extension_Updated
Inherited

Returns

\Zend_Gdata_App_Extension_Updated

Alias for saveXML() returns XML content for this element and all children

getXML() : string
Inherited

Returns

stringXML content

Get the full version of a namespace prefix

lookupNamespace(string $prefix, integer $majorVersion = 1, integer $minorVersion = null) : string
Inherited

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.

Parameters

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

Returns

string

Add an array of namespaces to the registered list.

registerAllNamespaces(array $namespaceArray) : void
Inherited

Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()

Parameters

$namespaceArray

array

An array of namespaces.

Add a namespace and prefix to the registered list

registerNamespace(string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0) : void
Inherited

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

Parameters

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

Reload the current entry. Returns a new copy of the entry as returned by the server, or null if no changes exist. This does not modify the current entry instance.

reload($uri = null, $className = null, array $extraHeaders = array()) : mixed
Inherited

Parameters

$uri

$className

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_Exception

Returns

mixedA new instance of the current entry with updated data, or null if the server reports that no changes have been made.

Uploads changes in this entry to the server using Zend_Gdata_App

save(string|null $uri = null, string|null $className = null, array $extraHeaders = array()) : \Zend_Gdata_App_Entry
Inherited

Parameters

$uri

stringnull

The URI to send requests to, or null if $data contains the URI.

$className

stringnull

The name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeaders

array

Extra headers to add to the request, as an array of string-based key/value pairs.

Exceptions

\Zend_Gdata_App_Exception

Returns

\Zend_Gdata_App_EntryThe updated entry.

Converts this element and all children into XML text using getDOM()

saveXML() : string
Inherited

Returns

stringXML content

Sets the list of the authors of this feed/entry. In an atom feed, each author is represented by an atom:author element

setAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

array

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Sets the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

setCategory(array $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

array

Array of Zend_Gdata_App_Extension_Category

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Sets the value of the atom:content element

setContent(\Zend_Gdata_App_Extension_Content $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Content

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

Sets the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

setContributor(array $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

array

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Sets the value of the app:control element

setControl(\Zend_Gdata_App_Extension_Control $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Control

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

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

setEmailList(\Zend_Gdata_Gapps_Extension_EmailList $value) : \Zend_Gdata_Gapps_EventEntry

This corresponds to the property in the Google Data protocol.

Parameters

$value

\Zend_Gdata_Gapps_Extension_EmailList

The desired value this element, or null to unset.

Returns

\Zend_Gdata_Gapps_EventEntryProvides a fluent interface

Set the Etag for the current entry to $value. Setting $value to null unsets the Etag.

setEtag(string|null $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

stringnull

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

Sets an array of all extension attributes not transformed into data model properties during parsing of the XML. 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

setExtensionAttributes(array $value) : \Zend_Gdata_App_Base
Inherited

Parameters

$value

array

All extension attributes

Returns

\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.

Sets an array of all elements not matched to data model classes during the parsing of the XML. This method can be used to add arbitrary child XML elements to any data model class.

setExtensionElements(array $value) : \Zend_Gdata_App_Base
Inherited

Parameters

$value

array

All extension elements

Returns

\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.

Set the HTTP client instance

setHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedEntryParent
Inherited

Sets the HTTP client object to use for retrieving the feed.

deprecated Deprecated as of Zend Framework 1.7. Use setService() instead.

Parameters

$httpClient

\Zend_Http_Client

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

setId()

setId(\Zend_Gdata_App_Extension_Id $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Id

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Set the major protocol version that should be used. Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

setMajorProtocolVersion(\(int|\NULL) $value) 
Inherited
see

Parameters

$value

\(int\NULL)

The major protocol version to use.

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Set the MediaSource object (file) for this MediaEntry

setMediaSource(\Zend_Gdata_App_MediaSource $value) : \Zend_Gdata_App_MediaEntry
Inherited

Parameters

$value

\Zend_Gdata_App_MediaSource

The attached MediaSource/file

Returns

\Zend_Gdata_App_MediaEntryProvides a fluent interface

Set the minor protocol version that should be used. If set to NULL, no minor protocol version will be sent to the server. Values < 0 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

setMinorProtocolVersion(\(int|\NULL) $value) 
Inherited
see

Parameters

$value

\(int\NULL)

The minor protocol version to use.

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Sets the value of the atom:published element This represents the publishing date for an entry

setPublished(\Zend_Gdata_App_Extension_Published $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Published

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

setRights()

setRights(\Zend_Gdata_App_Extension_Rights $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Rights

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Set the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

setService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$instance

\Zend_Gdata_App

The new service instance.

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface.

Sets the value of the atom:source element

setSource(\Zend_Gdata_App_Extension_Source $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Source

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

Sets the value of the atom:summary element This represents a textual summary of this entry's content

setSummary(\Zend_Gdata_App_Extension_Summary $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Summary

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

Sets the child text node of this element This represents any raw text contained within the XML element

setText(string $value) : \Zend_Gdata_App_Base
Inherited

Parameters

$value

string

Child text node

Returns

\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.

Returns the title of this feed or entry. The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

setTitle(\Zend_Gdata_App_Extension_Title $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Title

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

setUpdated()

setUpdated(\Zend_Gdata_App_Extension_Updated $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Updated

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Transfers each child and attribute into member variables.

transferFromDOM(\DOMNode $node) 
Inherited

This is called when XML is received over the wire and the data model needs to be built to represent this XML.

Parameters

$node

\DOMNode

The DOMNode that represents this object's data

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). The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.

transferFromXML(string $xml) 
Inherited

Parameters

$xml

string

The XML text to parse

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.

takeAttributeFromDOM(\DOMNode $attribute) 
Inherited

Parameters

$attribute

\DOMNode

The DOMNode attribute needed to be handled

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

takeChildFromDOM(\DOMNode $child) 
inherited_from \Zend_Gdata_Entry::takeChildFromDOM()

Parameters

$child

\DOMNode

The DOMNode to process

Given a child DOMNode, tries to determine how to map the data into object instance members. If no mapping is defined, Extension_Element objects are created and stored in an array.

takeChildFromDOM(\DOMNode $child) 
Inherited

Parameters

$child

\DOMNode

The DOMNode needed to be handled

 Properties

 

$_author

$_author 

Default

array()
 

$_category

$_category 

Default

array()
 

atom:content element

$_content : \Zend_Gdata_App_Extension_Content

Default

null
 

$_contributor

$_contributor 

Default

array()
 

app:control element

$_control : \Zend_Gdata_App_Extension_Control

Default

null
 

app:edited element

$_edited : \Zend_Gdata_App_Extension_Edited

Default

null
 

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

$_emailList : \Zend_Gdata_Gapps_Extension_EmailList

Default

null
 

$_entryClassName

$_entryClassName 

Default

'Zend_Gdata_Gapps_EmailListEntry'
inherited_from \Zend_Gdata_Entry::_entryClassName
 

Class name for each entry in this feed*

$_entryClassName : string

Default

'Zend_Gdata_App_Entry'
 

The HTTP ETag associated with this entry. Used for optimistic concurrency in protoco v2 or greater.

$_etag : string | null

Default

NULL
 

Leftover attributes which were not handled

$_extensionAttributes : array

Default

array()
 

Leftover elements which were not handled

$_extensionElements : array

Default

array()
   

$_id

$_id 

Default

null
   

Indicates the major protocol version that should be used.

$_majorProtocolVersion 

Default

1

At present, recognized values are either 1 or 2. However, any integer value >= 1 is considered valid.

see
see
 

The attached MediaSource/file

$_mediaSource : \Zend_Gdata_App_MediaSource

Default

null
 

Indicates the minor protocol version that should be used. Can be set to either an integer >= 0, or NULL if no minor version should be sent to the server.

$_minorProtocolVersion 

Default

null
see
see
 

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

$_namespaceLookupCache : array

Default

array()
Static
 

List of namespaces, as a three-dimensional array. 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.

$_namespaces : array

Default

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')))

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.

see
see
see
 

atom:published element

$_published : \Zend_Gdata_App_Extension_Published

Default

null
 

$_rights

$_rights 

Default

null
 

The XML element name, including prefix if desired

$_rootElement : string

Default

null
 

The XML namespace prefix

$_rootNamespace : string

Default

'atom'
 

The XML namespace URI - takes precedence over lookup up the corresponding URI for $_rootNamespace

$_rootNamespaceURI : string

Default

null
 

Service instance used to make network requests.

$_service 

Default

null
 

atom:source element

$_source : \Zend_Gdata_App_Extension_Source

Default

null
 

atom:summary element

$_summary : \Zend_Gdata_App_Extension_Summary

Default

null
 

XML child text node content

$_text : string

Default

null
 

$_title

$_title 

Default

null
 

$_updated

$_updated 

Default

null