Gdata/Gapps/GroupFeed.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

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:$  

\Zend_Gdata_Gapps_GroupFeed

Package: Zend\Gdata\Gapps
Data model for a collection of Google Apps group entries, usually provided by the Google Apps servers.

For information on requesting this feed from a server, see the Google Apps service class, Zend_Gdata_Gapps.

Parent(s)
\Zend_Gdata_Feed < \Zend_Gdata_App_Feed < \Zend_Gdata_App_FeedSourceParent < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_entry = array()
inherited
Cache of feed entries.
Inherited from: \Zend_Gdata_App_Feed::$$_entry\Zend_Gdata_Feed::$$_entry
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Feed::$$_entry  
Inherited_from
\Zend_Gdata_Feed::$$_entry  
>VPropertyprotectedstring $_entryClassName = 'Zend_Gdata_Gapps_GroupEntry'
The classname for individual feed elements.
Default value'Zend_Gdata_Gapps_GroupEntry'Details
Type
string
>VPropertyprotectedint $_entryIndex = 0
inherited
Current location in $_entry array
Inherited from: \Zend_Gdata_App_Feed::$$_entryIndex\Zend_Gdata_Feed::$$_entryIndex
Default value0Details
Type
int
Inherited_from
\Zend_Gdata_App_Feed::$$_entryIndex  
Inherited_from
\Zend_Gdata_Feed::$$_entryIndex  
>VPropertyprotectedstring|null $_etag = NULL

Used for optimistic concurrency in protoco v2 or greater.

Default valueNULLDetails
Type
string | null
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_etag  
Inherited_from
\Zend_Gdata_App_FeedSourceParent::$$_etag  
Inherited_from
\Zend_Gdata_App_Feed::$$_etag  
Inherited_from
\Zend_Gdata_Feed::$$_etag  
>VPropertyprotected$_feedClassName = 'Zend_Gdata_Gapps_GroupFeed'
Default value'Zend_Gdata_Gapps_GroupFeed'Details
Type
n/a
>VPropertyprotected\Zend_Gdata_Extension_OpenSearchItemsPerPage|null $_itemsPerPage = null
inherited
The openSearch:itemsPerPage element
Inherited from: \Zend_Gdata_Feed::$$_itemsPerPage
Default valuenullDetails
Type
\Zend_Gdata_Extension_OpenSearchItemsPerPage | null
Inherited_from
\Zend_Gdata_Feed::$$_itemsPerPage  
>VPropertyprotected$_majorProtocolVersion = 1

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

Default value1Details
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata_App_FeedSourceParent::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata_App_Feed::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata_Feed::$$_majorProtocolVersion  
See
\setMajorProtocolVersion()  
See
\getMajorProtocolVersion()  
>VPropertyprotected$_minorProtocolVersion = null

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

Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata_App_FeedSourceParent::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata_App_Feed::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata_Feed::$$_minorProtocolVersion  
See
\setMinorProtocolVersion()  
See
\getMinorProtocolVersion()  
>VPropertyprotectedarray $_namespaceLookupCache = array()
staticinherited

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

Inherited from: \Zend_Gdata_App_Base::$$_namespaceLookupCache\Zend_Gdata_App_FeedEntryParent::$$_namespaceLookupCache\Zend_Gdata_App_FeedSourceParent::$$_namespaceLookupCache\Zend_Gdata_App_Feed::$$_namespaceLookupCache\Zend_Gdata_Feed::$$_namespaceLookupCache
>VPropertyprotectedarray $_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.

Default valuearray('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_FeedEntryParent::$$_namespaces  
Inherited_from
\Zend_Gdata_App_FeedSourceParent::$$_namespaces  
Inherited_from
\Zend_Gdata_App_Feed::$$_namespaces  
Inherited_from
\Zend_Gdata_Feed::$$_namespaces  
See
\lookupNamespace()  
See
\registerNamespace()  
See
\registerAllNamespaces()  
>VPropertyprotectedstring $_rootElement = 'feed'
inherited
The root xml element of this data element
Inherited from: \Zend_Gdata_App_Feed::$$_rootElement\Zend_Gdata_Feed::$$_rootElement
Default value'feed'Details
Type
string
Inherited_from
\Zend_Gdata_App_Feed::$$_rootElement  
Inherited_from
\Zend_Gdata_Feed::$$_rootElement  
>VPropertyprotected$_service = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_service  
Inherited_from
\Zend_Gdata_App_FeedSourceParent::$$_service  
Inherited_from
\Zend_Gdata_App_Feed::$$_service  
Inherited_from
\Zend_Gdata_Feed::$$_service  
See
getService()  
>VPropertyprotected\Zend_Gdata_Extension_OpenSearchStartIndex|null $_startIndex = null
inherited
The openSearch:startIndex element
Inherited from: \Zend_Gdata_Feed::$$_startIndex
Default valuenullDetails
Type
\Zend_Gdata_Extension_OpenSearchStartIndex | null
Inherited_from
\Zend_Gdata_Feed::$$_startIndex  
>VPropertyprotected\Zend_Gdata_Extension_OpenSearchTotalResults|null $_totalResults = null
inherited
The openSearch:totalResults element
Inherited from: \Zend_Gdata_Feed::$$_totalResults
Default valuenullDetails
Type
\Zend_Gdata_Extension_OpenSearchTotalResults | null
Inherited_from
\Zend_Gdata_Feed::$$_totalResults  

Methods

methodpublic__construct( $element = null) : void
inherited

Constructs a Feed or Entry

Inherited from: \Zend_Gdata_Feed::__construct()
Parameters
NameTypeDescription
$element
methodpublic__get(string $var) : mixed
inherited

Make accessing some individual elements of the feed easier.

Inherited from: \Zend_Gdata_App_Feed::__get()\Zend_Gdata_Feed::__get()

Special accessors 'entry' and 'entries' are provided so that if you wish to iterate over an Atom feed's entries, you can do so using foreach ($feed->entries as $entry) or foreach ($feed->entry as $entry).

Parameters
NameTypeDescription
$varstring

The property to get.

Returns
TypeDescription
mixed
methodpublic__set(string $name,  $val) : void
inherited

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_FeedEntryParent::__set()\Zend_Gdata_App_FeedSourceParent::__set()\Zend_Gdata_App_Feed::__set()\Zend_Gdata_Feed::__set()

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

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring
$val
methodpublic__toString() : string
Returns
TypeDescription
stringThe text representation of this object
methodpublicaddEntry(\Zend_Gdata_App_Entry $value) : \Zend_Gdata_App_Feed
inherited

Adds an entry representation to the array of entries contained within this feed

Inherited from: \Zend_Gdata_App_Feed::addEntry()\Zend_Gdata_Feed::addEntry()
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Entry

An individual entry to add.

Returns
TypeDescription
\Zend_Gdata_App_FeedProvides a fluent interface
methodpubliccount() : integer
inherited

Get the number of entries in this feed object.

Inherited from: \Zend_Gdata_App_Feed::count()\Zend_Gdata_Feed::count()
Returns
TypeDescription
integerEntry count.
methodpubliccurrent() : mixed
inherited

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::current()\Zend_Gdata_Feed::current()
Returns
TypeDescription
mixedThe current row, or null if no rows.
methodpublicencode() : string

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

Returns
TypeDescription
stringEncoded string content
methodpublicflushNamespaceLookupCache() : void

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

methodpublicgetAlternateLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the Zend_Gdata_App_Extension_Link element which represents the URL for an alternate view of the data represented by this feed or entry.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getAlternateLink()\Zend_Gdata_App_FeedSourceParent::getAlternateLink()\Zend_Gdata_App_Feed::getAlternateLink()\Zend_Gdata_Feed::getAlternateLink()

This alternate view is commonly a user-facing webpage, blog post, etc. The MIME type for the data at the URL is available from the returned Zend_Gdata_App_Extension_Link element. This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetCategory() : array

Each category is represented in an atom feed by an atom:category element.

Returns
TypeDescription
arrayArray of Zend_Gdata_App_Extension_Category
methodpublicgetContributor() : array

Each contributor is represented in an atom feed by an atom:contributor XML element

Returns
TypeDescription
arrayAn array of Zend_Gdata_App_Extension_Contributor
methodpublicgetDOM(\DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null) : \DOMElement
inherited

Retrieves the DOM model representing this object and all children

Inherited from: \Zend_Gdata_Feed::getDOM()

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.

Parameters
NameTypeDescription
$doc\DOMDocument
$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElement
methodpublicgetEditLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getEditLink()\Zend_Gdata_App_FeedSourceParent::getEditLink()\Zend_Gdata_App_Feed::getEditLink()\Zend_Gdata_Feed::getEditLink()

This link is in the atom feed/entry as an atom:link with a rel attribute value of 'edit'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetEntry() : array
inherited

Gets the array of atom:entry elements contained within this atom:feed representation

Inherited from: \Zend_Gdata_App_Feed::getEntry()\Zend_Gdata_Feed::getEntry()
Returns
TypeDescription
arrayZend_Gdata_App_Entry array
methodpublicgetEtag() : string | null
Returns
TypeDescription
string | null
methodpublicgetExtensionAttributes() : array

Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);

Returns
TypeDescription
arrayAll extension attributes
methodpublicgetExtensionElements() : array
Returns
TypeDescription
arrayAll elements not matched to data model classes during parsing
methodpublicgetGenerator() : \Zend_Gdata_AppExtension_Generator
Returns
TypeDescription
\Zend_Gdata_AppExtension_Generator
methodpublicgetHttpClient() : \Zend_Http_Client_Abstract

If none is set, a new Zend_Http_Client will be used.

Returns
TypeDescription
\Zend_Http_Client_Abstract
methodpublicgetIcon() : \Zend_Gdata_AppExtension_Icon
Returns
TypeDescription
\Zend_Gdata_AppExtension_Icon
methodpublicgetItemsPerPage() : \Zend_Gdata_Extension_OpenSearchItemsPerPage | null
inherited

Get the value of the itemsPerPage property.

Inherited from: \Zend_Gdata_Feed::getItemsPerPage()
Returns
TypeDescription
\Zend_Gdata_Extension_OpenSearchItemsPerPage | nullThe value of the itemsPerPage property, or null if unset.
methodpublicgetLink(string $rel = null) : mixed
inherited

Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getLink()\Zend_Gdata_App_FeedSourceParent::getLink()\Zend_Gdata_App_Feed::getLink()\Zend_Gdata_Feed::getLink()

If the 'rel' value is not provided, the full array of Zend_Gdata_App_Extension_Link elements is returned. In an atom feed, each link is represented by an atom:link element. The 'rel' value passed to this function is the atom:link/@rel attribute. Example rel values include 'self', 'edit', and 'alternate'.

Parameters
NameTypeDescription
$relstring

The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned

Returns
TypeDescription
mixedEither a single Zend_Gdata_App_Extension_link element, an array of the same or null is returned depending on the rel value supplied as the argument to this function
methodpublicgetMajorProtocolVersion() : \(int | \NULL)
Returns
TypeDescription
\(int | \NULL)The major protocol version in use.
Details
See
\_majorProtocolVersion  
methodpublicgetMinorProtocolVersion() : \(int | \NULL)
Returns
TypeDescription
\(int | \NULL)The major protocol version in use, or NULL if no minor version is specified.
Details
See
\_minorProtocolVersion  
methodpublicgetNextFeed() : mixed | null
inherited

Retrieve the next set of results from this feed.

Inherited from: \Zend_Gdata_App_Feed::getNextFeed()\Zend_Gdata_Feed::getNextFeed()
Returns
TypeDescription
mixed | nullReturns the next set of results as a feed of the same class as this feed, or null if no results exist.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicgetNextLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the next chunk of results when paging through a feed.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getNextLink()\Zend_Gdata_App_FeedSourceParent::getNextLink()\Zend_Gdata_App_Feed::getNextLink()\Zend_Gdata_Feed::getNextLink()

This link is in the atom feed as an atom:link with a rel attribute value of 'next'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetPreviousFeed() : mixed | null
inherited

Retrieve the previous set of results from this feed.

Inherited from: \Zend_Gdata_App_Feed::getPreviousFeed()\Zend_Gdata_Feed::getPreviousFeed()
Returns
TypeDescription
mixed | nullReturns the previous set of results as a feed of the same class as this feed, or null if no results exist.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicgetPreviousLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the previous chunk of results when paging through a feed.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getPreviousLink()\Zend_Gdata_App_FeedSourceParent::getPreviousLink()\Zend_Gdata_App_Feed::getPreviousLink()\Zend_Gdata_Feed::getPreviousLink()

This link is in the atom feed as an atom:link with a rel attribute value of 'previous'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetRights() : \Zend_Gdata_AppExtension_Rights
Returns
TypeDescription
\Zend_Gdata_AppExtension_Rights
methodpublicgetSelfLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the entry or feed represented by this object This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getSelfLink()\Zend_Gdata_App_FeedSourceParent::getSelfLink()\Zend_Gdata_App_Feed::getSelfLink()\Zend_Gdata_Feed::getSelfLink()
Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetService() : \Zend_Gdata_App | null

This will be used to perform network requests, such as when calling save() and delete().

Returns
TypeDescription
\Zend_Gdata_App | nullThe current service instance, or null if not set.
methodpublicgetStartIndex() : \Zend_Gdata_Extension_OpenSearchStartIndex | null
inherited

Get the value of the startIndex property.

Inherited from: \Zend_Gdata_Feed::getStartIndex()
Returns
TypeDescription
\Zend_Gdata_Extension_OpenSearchStartIndex | nullThe value of the startIndex property, or null if unset.
methodpublicgetSubtitle() : \Zend_Gdata_AppExtension_Subtitle
Returns
TypeDescription
\Zend_Gdata_AppExtension_Subtitle
methodpublicgetText( $trim = true) : string
inherited

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_FeedEntryParent::getText()\Zend_Gdata_App_FeedSourceParent::getText()\Zend_Gdata_App_Feed::getText()\Zend_Gdata_Feed::getText()
Parameters
NameTypeDescription
$trim
Returns
TypeDescription
stringChild text node
methodpublicgetTitle() : \Zend_Gdata_App_Extension_Title

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
TypeDescription
\Zend_Gdata_App_Extension_Title
methodpublicgetTitleValue() : string

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
TypeDescription
string
methodpublicgetTotalResults() : \Zend_Gdata_Extension_OpenSearchTotalResults | null
inherited

Get the value of the totalResults property.

Inherited from: \Zend_Gdata_Feed::getTotalResults()
Returns
TypeDescription
\Zend_Gdata_Extension_OpenSearchTotalResults | nullThe value of the totalResults property, or null if unset.
methodpublicgetXML() : string
Returns
TypeDescription
stringXML content
methodpublicgetlogo() : \Zend_Gdata_AppExtension_logo
Returns
TypeDescription
\Zend_Gdata_AppExtension_logo
methodpublickey() : mixed
inherited

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::key()\Zend_Gdata_Feed::key()
Returns
TypeDescription
mixedThe current row number (starts at 0), or NULL if no rows
methodpubliclookupNamespace(string $prefix, integer $majorVersion = null, integer $minorVersion = null) : string

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.

The current entry or feed's version will be used when performing the namespace lookup unless overridden using $majorVersion and $minorVersion. If the entry/fee has a null version, then the latest protocol version will be used by default.

Parameters
NameTypeDescription
$prefixstring

The namespace prefix to lookup.

$majorVersioninteger

The major protocol version in effect. Defaults to null (auto-select).

$minorVersioninteger

The minor protocol version in effect. Defaults to null (auto-select).

Returns
TypeDescription
string
methodpublicnext() : mixed
inherited

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::next()\Zend_Gdata_Feed::next()
Returns
TypeDescription
mixedThe next row, or null if no more rows.
methodpublicoffsetExists(int $key) : boolean
inherited

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetExists()\Zend_Gdata_Feed::offsetExists()
Parameters
NameTypeDescription
$keyint

The index to check for existence

Returns
TypeDescription
boolean
methodpublicoffsetGet(int $key) : void
inherited

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetGet()\Zend_Gdata_Feed::offsetGet()
Parameters
NameTypeDescription
$keyint

The index to get

methodpublicoffsetSet(int $key, \Zend_Gdata_App_Entry $value) : void
inherited

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetSet()\Zend_Gdata_Feed::offsetSet()
Parameters
NameTypeDescription
$keyint

The index to set

$value\Zend_Gdata_App_Entry

The value to set

methodpublicoffsetUnset(int $key) : void
inherited

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetUnset()\Zend_Gdata_Feed::offsetUnset()
Parameters
NameTypeDescription
$keyint

The index to set

methodpublicregisterAllNamespaces(array $namespaceArray) : void

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
NameTypeDescription
$namespaceArrayarray

An array of namespaces.

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

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
NameTypeDescription
$prefixstring

The namespace prefix

$namespaceUristring

The full namespace URI

$majorVersioninteger

The major protocol version in effect. Defaults to '1'.

$minorVersioninteger

The minor protocol version in effect. Defaults to null (use latest).

methodpublicrewind() : void
inherited

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::rewind()\Zend_Gdata_Feed::rewind()
methodpublicsaveXML() : string
Returns
TypeDescription
stringXML content
methodpublicsetAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent

In an atom feed, each author is represented by an atom:author element

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetCategory(array $value) : \Zend_Gdata_App_FeedEntryParent

Each category is represented in an atom feed by an atom:category element.

Parameters
NameTypeDescription
$valuearray

Array of Zend_Gdata_App_Extension_Category

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetContributor(array $value) : \Zend_Gdata_App_FeedEntryParent

Each contributor is represented in an atom feed by an atom:contributor XML element

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetEntry(array $value) : \Zend_Gdata_App_Feed
inherited

Sets the array of atom:entry elements contained within this atom:feed representation

Inherited from: \Zend_Gdata_App_Feed::setEntry()\Zend_Gdata_Feed::setEntry()
Parameters
NameTypeDescription
$valuearray

The array of Zend_Gdata_App_Entry elements

Returns
TypeDescription
\Zend_Gdata_App_FeedProvides a fluent interface
methodpublicsetEtag(string | null $value) : \Zend_Gdata_App_Entry

Setting $value to null unsets the Etag.

Parameters
NameTypeDescription
$valuestring | null
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetExtensionAttributes(array $value) : \Zend_Gdata_App_Base

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

Parameters
NameTypeDescription
$valuearray

All extension attributes

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetExtensionElements(array $value) : \Zend_Gdata_App_Base

This method can be used to add arbitrary child XML elements to any data model class.

Parameters
NameTypeDescription
$valuearray

All extension elements

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedSourceParent

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

Parameters
NameTypeDescription
$httpClient\Zend_Http_Client
Returns
TypeDescription
\Zend_Gdata_App_FeedSourceParentProvides a fluent interface
methodpublicsetItemsPerPage(\Zend_Gdata_Extension_OpenSearchItemsPerPage | null $value) : \Zend_Gdata_Feed
inherited

Set the itemsPerPage property.

Inherited from: \Zend_Gdata_Feed::setItemsPerPage()
Parameters
NameTypeDescription
$value\Zend_Gdata_Extension_OpenSearchItemsPerPage | null

The value for the itemsPerPage property. Use nul to unset.

Returns
TypeDescription
\Zend_Gdata_FeedProvides a fluent interface.
methodpublicsetLink(array $value) : \Zend_Gdata_App_FeedEntryParent
Parameters
NameTypeDescription
$valuearray

The array of Zend_Gdata_App_Extension_Link elements

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetMajorProtocolVersion(\(int | \NULL) $value) : void
inherited

Set the major protocol version that should be used.

Inherited from: \Zend_Gdata_App_Feed::setMajorProtocolVersion()\Zend_Gdata_Feed::setMajorProtocolVersion()

Values < 1 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

This value will be propogated to all child entries.

Parameters
NameTypeDescription
$value\(int | \NULL)

The major protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_majorProtocolVersion  
methodpublicsetMinorProtocolVersion(\(int | \NULL) $value) : void
inherited

Set the minor protocol version that should be used.

Inherited from: \Zend_Gdata_App_Feed::setMinorProtocolVersion()\Zend_Gdata_Feed::setMinorProtocolVersion()

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.

This value will be propogated to all child entries.

Parameters
NameTypeDescription
$value\(int | \NULL)

The minor protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_minorProtocolVersion  
methodpublicsetService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent
inherited

Set the active service instance for this feed and all enclosed entries.

Inherited from: \Zend_Gdata_App_FeedSourceParent::setService()\Zend_Gdata_App_Feed::setService()\Zend_Gdata_Feed::setService()

This will be used to perform network requests, such as when calling save() and delete().

Parameters
NameTypeDescription
$instance\Zend_Gdata_App

The new service instance.

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface.
methodpublicsetStartIndex(\Zend_Gdata_Extension_OpenSearchStartIndex | null $value) : \Zend_Gdata_Feed
inherited

Set the start index property for feed paging.

Inherited from: \Zend_Gdata_Feed::setStartIndex()
Parameters
NameTypeDescription
$value\Zend_Gdata_Extension_OpenSearchStartIndex | null

The value for the startIndex property. Use null to unset.

Returns
TypeDescription
\Zend_Gdata_FeedProvides a fluent interface.
methodpublicsetText(string $value) : \Zend_Gdata_App_Base
inherited

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_FeedEntryParent::setText()\Zend_Gdata_App_FeedSourceParent::setText()\Zend_Gdata_App_Feed::setText()\Zend_Gdata_Feed::setText()
Parameters
NameTypeDescription
$valuestring

Child text node

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetTitle(\Zend_Gdata_App_Extension_Title $value) : \Zend_Gdata_App_FeedEntryParent

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

Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Title
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetTotalResults(\Zend_Gdata_Extension_OpenSearchTotalResults | null $value) : \Zend_Gdata_Feed
inherited

Set the value of the totalResults property.

Inherited from: \Zend_Gdata_Feed::setTotalResults()
Parameters
NameTypeDescription
$value\Zend_Gdata_Extension_OpenSearchTotalResults | null

The value of the totalResults property. Use null to unset.

Returns
TypeDescription
\Zend_Gdata_FeedProvides a fluent interface.
methodpublicsetlogo(\Zend_Gdata_App_Extension_logo $value) : \Zend_Gdata_App_FeedSourceParent
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_logo
Returns
TypeDescription
\Zend_Gdata_App_FeedSourceParentProvides a fluent interface
methodprotectedtakeAttributeFromDOM(\DOMNode $attribute) : void
inherited

Given a DOMNode representing an attribute, tries to map the data into instance members.

Inherited from: \Zend_Gdata_Feed::takeAttributeFromDOM()

If no mapping is defined, the name and value are stored in an array.

Parameters
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void
inherited

Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

Inherited from: \Zend_Gdata_Feed::takeChildFromDOM()

If no mapping is defined, Extension_Element objects are created and stored in an array.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

methodpublictransferFromDOM(\DOMNode $node) : void

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

Parameters
NameTypeDescription
$node\DOMNode

The DOMNode that represents this object's data

methodpublictransferFromXML(string $xml) : void
inherited

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_FeedEntryParent::transferFromXML()\Zend_Gdata_App_FeedSourceParent::transferFromXML()\Zend_Gdata_App_Feed::transferFromXML()\Zend_Gdata_Feed::transferFromXML()

The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.

Parameters
NameTypeDescription
$xmlstring

The XML text to parse

methodpublicvalid() : boolean
inherited

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::valid()\Zend_Gdata_Feed::valid()
Returns
TypeDescription
booleanWhether the iteration is valid
Documentation was generated by phpDocumentor 2.0.0a12.