Gdata/Books/CollectionFeed.php

+ Show: +

inherited

+ Classes +
- \Zend_Gdata_Books_CollectionFeed

+ 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: Books + +
Version: $Id: CollectionFeed.php 24593 2012-01-05 20:35:02Z matthew $ + +

\Zend_Gdata_Books_CollectionFeed
jump to top

Package: Zend\Gdata\Books

Describes a Book Search collection feed

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

$_author = array()

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_author \Zend_Gdata_App_FeedSourceParent::$$_author \Zend_Gdata_App_Feed::$$_author \Zend_Gdata_Feed::$$_author

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_author + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_author + +
Inherited_from: \Zend_Gdata_App_Feed::$$_author + +
Inherited_from: \Zend_Gdata_Feed::$$_author + +

$_category = array()

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_category \Zend_Gdata_App_FeedSourceParent::$$_category \Zend_Gdata_App_Feed::$$_category \Zend_Gdata_Feed::$$_category

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_category + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_category + +
Inherited_from: \Zend_Gdata_App_Feed::$$_category + +
Inherited_from: \Zend_Gdata_Feed::$$_category + +

$_contributor = array()

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_contributor \Zend_Gdata_App_FeedSourceParent::$$_contributor \Zend_Gdata_App_Feed::$$_contributor \Zend_Gdata_Feed::$$_contributor

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_contributor + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_contributor + +
Inherited_from: \Zend_Gdata_App_Feed::$$_contributor + +
Inherited_from: \Zend_Gdata_Feed::$$_contributor + +

array $_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 + +

string $_entryClassName = 'Zend_Gdata_Books_CollectionEntry'

The classname for individual feed elements.

Default value'Zend_Gdata_Books_CollectionEntry'Details

Type: string

int $_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 + +

string|null $_etag = NULL

inherited

The HTTP ETag associated with this entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::$$_etag \Zend_Gdata_App_FeedSourceParent::$$_etag \Zend_Gdata_App_Feed::$$_etag \Zend_Gdata_Feed::$$_etag

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

array $_extensionAttributes = array()

inherited

Leftover attributes which were not handled

Inherited from: + \Zend_Gdata_App_Base::$$_extensionAttributes \Zend_Gdata_App_FeedEntryParent::$$_extensionAttributes \Zend_Gdata_App_FeedSourceParent::$$_extensionAttributes \Zend_Gdata_App_Feed::$$_extensionAttributes \Zend_Gdata_Feed::$$_extensionAttributes

Default valuearray()Details

Type: array
Inherited_from: \Zend_Gdata_App_Base::$$_extensionAttributes + +
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_extensionAttributes + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_extensionAttributes + +
Inherited_from: \Zend_Gdata_App_Feed::$$_extensionAttributes + +
Inherited_from: \Zend_Gdata_Feed::$$_extensionAttributes + +

array $_extensionElements = array()

inherited

Leftover elements which were not handled

Inherited from: + \Zend_Gdata_App_Base::$$_extensionElements \Zend_Gdata_App_FeedEntryParent::$$_extensionElements \Zend_Gdata_App_FeedSourceParent::$$_extensionElements \Zend_Gdata_App_Feed::$$_extensionElements \Zend_Gdata_Feed::$$_extensionElements

Default valuearray()Details

Type: array
Inherited_from: \Zend_Gdata_App_Base::$$_extensionElements + +
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_extensionElements + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_extensionElements + +
Inherited_from: \Zend_Gdata_App_Feed::$$_extensionElements + +
Inherited_from: \Zend_Gdata_Feed::$$_extensionElements + +

$_generator = null

inheritedInherited from: + \Zend_Gdata_App_FeedSourceParent::$$_generator \Zend_Gdata_App_Feed::$$_generator \Zend_Gdata_Feed::$$_generator

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_generator + +
Inherited_from: \Zend_Gdata_App_Feed::$$_generator + +
Inherited_from: \Zend_Gdata_Feed::$$_generator + +

$_icon = null

inheritedInherited from: + \Zend_Gdata_App_FeedSourceParent::$$_icon \Zend_Gdata_App_Feed::$$_icon \Zend_Gdata_Feed::$$_icon

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_icon + +
Inherited_from: \Zend_Gdata_App_Feed::$$_icon + +
Inherited_from: \Zend_Gdata_Feed::$$_icon + +

$_id = null

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_id \Zend_Gdata_App_FeedSourceParent::$$_id \Zend_Gdata_App_Feed::$$_id \Zend_Gdata_Feed::$$_id

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_id + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_id + +
Inherited_from: \Zend_Gdata_App_Feed::$$_id + +
Inherited_from: \Zend_Gdata_Feed::$$_id + +

\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 + +

$_link = array()

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_link \Zend_Gdata_App_FeedSourceParent::$$_link \Zend_Gdata_App_Feed::$$_link \Zend_Gdata_Feed::$$_link

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_link + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_link + +
Inherited_from: \Zend_Gdata_App_Feed::$$_link + +
Inherited_from: \Zend_Gdata_Feed::$$_link + +

$_logo = null

inheritedInherited from: + \Zend_Gdata_App_FeedSourceParent::$$_logo \Zend_Gdata_App_Feed::$$_logo \Zend_Gdata_Feed::$$_logo

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_logo + +
Inherited_from: \Zend_Gdata_App_Feed::$$_logo + +
Inherited_from: \Zend_Gdata_Feed::$$_logo + +

$_majorProtocolVersion = 1

inherited

Indicates the major protocol version that should be used.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::$$_majorProtocolVersion \Zend_Gdata_App_FeedSourceParent::$$_majorProtocolVersion \Zend_Gdata_App_Feed::$$_majorProtocolVersion \Zend_Gdata_Feed::$$_majorProtocolVersion

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

$_minorProtocolVersion = null

inherited

Indicates the minor protocol version that should be used.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::$$_minorProtocolVersion \Zend_Gdata_App_FeedSourceParent::$$_minorProtocolVersion \Zend_Gdata_App_Feed::$$_minorProtocolVersion \Zend_Gdata_Feed::$$_minorProtocolVersion

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

array $_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

Default valuearray()Details

Type: array
Inherited_from: \Zend_Gdata_App_Base::$$_namespaceLookupCache + +
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_namespaceLookupCache + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_namespaceLookupCache + +
Inherited_from: \Zend_Gdata_App_Feed::$$_namespaceLookupCache + +
Inherited_from: \Zend_Gdata_Feed::$$_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')))

inherited

List of namespaces, as a three-dimensional array.

Inherited from: + \Zend_Gdata_App_Base::$$_namespaces \Zend_Gdata_App_FeedEntryParent::$$_namespaces \Zend_Gdata_App_FeedSourceParent::$$_namespaces \Zend_Gdata_App_Feed::$$_namespaces \Zend_Gdata_Feed::$$_namespaces

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 value

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_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() + +

$_rights = null

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_rights \Zend_Gdata_App_FeedSourceParent::$$_rights \Zend_Gdata_App_Feed::$$_rights \Zend_Gdata_Feed::$$_rights

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_rights + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_rights + +
Inherited_from: \Zend_Gdata_App_Feed::$$_rights + +
Inherited_from: \Zend_Gdata_Feed::$$_rights + +

string $_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 + +

string $_rootNamespace = 'atom'

inherited

The XML namespace prefix

Inherited from: + \Zend_Gdata_App_Base::$$_rootNamespace \Zend_Gdata_App_FeedEntryParent::$$_rootNamespace \Zend_Gdata_App_FeedSourceParent::$$_rootNamespace \Zend_Gdata_App_Feed::$$_rootNamespace \Zend_Gdata_Feed::$$_rootNamespace

Default value'atom'Details

Type: string
Inherited_from: \Zend_Gdata_App_Base::$$_rootNamespace + +
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_rootNamespace + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_rootNamespace + +
Inherited_from: \Zend_Gdata_App_Feed::$$_rootNamespace + +
Inherited_from: \Zend_Gdata_Feed::$$_rootNamespace + +

string $_rootNamespaceURI = null

inherited

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

Inherited from: + \Zend_Gdata_App_Base::$$_rootNamespaceURI \Zend_Gdata_App_FeedEntryParent::$$_rootNamespaceURI \Zend_Gdata_App_FeedSourceParent::$$_rootNamespaceURI \Zend_Gdata_App_Feed::$$_rootNamespaceURI \Zend_Gdata_Feed::$$_rootNamespaceURI

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_App_Base::$$_rootNamespaceURI + +
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_rootNamespaceURI + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_rootNamespaceURI + +
Inherited_from: \Zend_Gdata_App_Feed::$$_rootNamespaceURI + +
Inherited_from: \Zend_Gdata_Feed::$$_rootNamespaceURI + +

$_service = null

inherited

Service instance used to make network requests.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::$$_service \Zend_Gdata_App_FeedSourceParent::$$_service \Zend_Gdata_App_Feed::$$_service \Zend_Gdata_Feed::$$_service

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

\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 + +

$_subtitle = null

inheritedInherited from: + \Zend_Gdata_App_FeedSourceParent::$$_subtitle \Zend_Gdata_App_Feed::$$_subtitle \Zend_Gdata_Feed::$$_subtitle

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_subtitle + +
Inherited_from: \Zend_Gdata_App_Feed::$$_subtitle + +
Inherited_from: \Zend_Gdata_Feed::$$_subtitle + +

string $_text = null

inherited

XML child text node content

Inherited from: + \Zend_Gdata_App_Base::$$_text \Zend_Gdata_App_FeedEntryParent::$$_text \Zend_Gdata_App_FeedSourceParent::$$_text \Zend_Gdata_App_Feed::$$_text \Zend_Gdata_Feed::$$_text

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_App_Base::$$_text + +
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_text + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_text + +
Inherited_from: \Zend_Gdata_App_Feed::$$_text + +
Inherited_from: \Zend_Gdata_Feed::$$_text + +

$_title = null

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_title \Zend_Gdata_App_FeedSourceParent::$$_title \Zend_Gdata_App_Feed::$$_title \Zend_Gdata_Feed::$$_title

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_title + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_title + +
Inherited_from: \Zend_Gdata_App_Feed::$$_title + +
Inherited_from: \Zend_Gdata_Feed::$$_title + +

\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 + +

$_updated = null

inheritedInherited from: + \Zend_Gdata_App_FeedEntryParent::$$_updated \Zend_Gdata_App_FeedSourceParent::$$_updated \Zend_Gdata_App_Feed::$$_updated \Zend_Gdata_Feed::$$_updated

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Gdata_App_FeedEntryParent::$$_updated + +
Inherited_from: \Zend_Gdata_App_FeedSourceParent::$$_updated + +
Inherited_from: \Zend_Gdata_App_Feed::$$_updated + +
Inherited_from: \Zend_Gdata_Feed::$$_updated + +

Methods

__construct(\DOMElement $element = null) : void

Constructor for Zend_Gdata_Books_CollectionFeed which +Describes a Book Search collection feed

Parameters

Name	Type	Description
$element	\DOMElement	(optional) DOMElement from which this + object should be constructed. +

__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

Name	Type	Description
$var	string	The property to get.

Returns

Type	Description
mixed

__isset(string $name) : void

inherited

Magic __isset method

Inherited from: + \Zend_Gdata_App_Base::__isset()\Zend_Gdata_App_FeedEntryParent::__isset()\Zend_Gdata_App_FeedSourceParent::__isset()\Zend_Gdata_App_Feed::__isset()\Zend_Gdata_Feed::__isset()

Parameters

Name	Type	Description
$name	string

__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

Name	Type	Description
$name	string
$val

__toString() : string

inherited

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

Inherited from: + \Zend_Gdata_App_Base::__toString()\Zend_Gdata_App_FeedEntryParent::__toString()\Zend_Gdata_App_FeedSourceParent::__toString()\Zend_Gdata_App_Feed::__toString()\Zend_Gdata_Feed::__toString()

Returns

Type	Description
string	The text representation of this object

__unset(string $name) : void

inherited

Magic __unset method

Inherited from: + \Zend_Gdata_App_Base::__unset()\Zend_Gdata_App_FeedEntryParent::__unset()\Zend_Gdata_App_FeedSourceParent::__unset()\Zend_Gdata_App_Feed::__unset()\Zend_Gdata_Feed::__unset()

Parameters

Name	Type	Description
$name	string

addEntry(\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

Name	Type	Description
$value	\Zend_Gdata_App_Entry	An individual entry to add.

Returns

Type	Description
\Zend_Gdata_App_Feed	Provides a fluent interface

count() : integer

inherited

Get the number of entries in this feed object.

Inherited from: + \Zend_Gdata_App_Feed::count()\Zend_Gdata_Feed::count()

Returns

Type	Description
integer	Entry count.

current() : mixed

inherited

Required by the Iterator interface.

Inherited from: + \Zend_Gdata_App_Feed::current()\Zend_Gdata_Feed::current()

Returns

Type	Description
mixed	The current row, or null if no rows.

encode() : string

inherited

Alias for saveXML()

Inherited from: + \Zend_Gdata_App_Base::encode()\Zend_Gdata_App_FeedEntryParent::encode()\Zend_Gdata_App_FeedSourceParent::encode()\Zend_Gdata_App_Feed::encode()\Zend_Gdata_Feed::encode()

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

Returns

Type	Description
string	Encoded string content

flushNamespaceLookupCache() : void

staticinherited

Flush namespace lookup cache.

Inherited from: + \Zend_Gdata_App_Base::flushNamespaceLookupCache()\Zend_Gdata_App_FeedEntryParent::flushNamespaceLookupCache()\Zend_Gdata_App_FeedSourceParent::flushNamespaceLookupCache()\Zend_Gdata_App_Feed::flushNamespaceLookupCache()\Zend_Gdata_Feed::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().

getAlternateLink() : \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

Type	Description
\Zend_Gdata_App_Extension_Link	The link, or null if not found

getAuthor() : \Zend_Gdata_App_Extension_Author

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getAuthor()\Zend_Gdata_App_FeedSourceParent::getAuthor()\Zend_Gdata_App_Feed::getAuthor()\Zend_Gdata_Feed::getAuthor()

Returns

Type	Description
\Zend_Gdata_App_Extension_Author

getCategory() : array

inherited

Returns the array of categories that classify this feed/entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getCategory()\Zend_Gdata_App_FeedSourceParent::getCategory()\Zend_Gdata_App_Feed::getCategory()\Zend_Gdata_Feed::getCategory()

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

Returns

Type	Description
array	Array of Zend_Gdata_App_Extension_Category

getContributor() : array

inherited

Returns the array of contributors to this feed/entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getContributor()\Zend_Gdata_App_FeedSourceParent::getContributor()\Zend_Gdata_App_Feed::getContributor()\Zend_Gdata_Feed::getContributor()

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

Returns

Type	Description
array	An array of Zend_Gdata_App_Extension_Contributor

getDOM(\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

Name	Type	Description
$doc	\DOMDocument
$majorVersion
$minorVersion

Returns

Type	Description
\DOMElement

getEditLink() : \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

Type	Description
\Zend_Gdata_App_Extension_Link	The link, or null if not found

getEntry() : 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

Type	Description
array	Zend_Gdata_App_Entry array

getEtag() : string | null

inherited

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

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getEtag()\Zend_Gdata_App_FeedSourceParent::getEtag()\Zend_Gdata_App_Feed::getEtag()\Zend_Gdata_Feed::getEtag()

Returns

Type	Description
string \| null

getExtensionAttributes() : array

inherited

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

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

Returns

Type	Description
array	All extension attributes

getExtensionElements() : array

inherited

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

Returns

Type	Description
array	All elements not matched to data model classes during parsing

getGenerator() : \Zend_Gdata_AppExtension_Generator

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::getGenerator()\Zend_Gdata_App_Feed::getGenerator()\Zend_Gdata_Feed::getGenerator()

Returns

Type	Description
\Zend_Gdata_AppExtension_Generator

getHttpClient() : \Zend_Http_Client_Abstract

inherited

Gets the HTTP client object.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getHttpClient()\Zend_Gdata_App_FeedSourceParent::getHttpClient()\Zend_Gdata_App_Feed::getHttpClient()\Zend_Gdata_Feed::getHttpClient()

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

Returns

Type	Description
\Zend_Http_Client_Abstract

getIcon() : \Zend_Gdata_AppExtension_Icon

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::getIcon()\Zend_Gdata_App_Feed::getIcon()\Zend_Gdata_Feed::getIcon()

Returns

Type	Description
\Zend_Gdata_AppExtension_Icon

getId() : \Zend_Gdata_App_Extension_Id

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getId()\Zend_Gdata_App_FeedSourceParent::getId()\Zend_Gdata_App_Feed::getId()\Zend_Gdata_Feed::getId()

Returns

Type	Description
\Zend_Gdata_App_Extension_Id

getItemsPerPage() : \Zend_Gdata_Extension_OpenSearchItemsPerPage | null

inherited

Get the value of the itemsPerPage property.

Inherited from: + \Zend_Gdata_Feed::getItemsPerPage()

Returns

Type	Description
\Zend_Gdata_Extension_OpenSearchItemsPerPage \| null	The value of + the itemsPerPage property, or null if unset.

getLicenseLink() : \Zend_Gdata_App_Extension_Link

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getLicenseLink()\Zend_Gdata_App_FeedSourceParent::getLicenseLink()\Zend_Gdata_App_Feed::getLicenseLink()\Zend_Gdata_Feed::getLicenseLink()

Returns

Type	Description
\Zend_Gdata_App_Extension_Link

getLink(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

Name	Type	Description
$rel	string	The rel value of the link to be found. If null, + the array of Zend_Gdata_App_Extension_link elements is returned

Returns

Type	Description
mixed	Either 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

getMajorProtocolVersion() : \(int | \NULL)

inherited

Get the major protocol version that is in use.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()\Zend_Gdata_App_FeedSourceParent::getMajorProtocolVersion()\Zend_Gdata_App_Feed::getMajorProtocolVersion()\Zend_Gdata_Feed::getMajorProtocolVersion()

Returns

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

Details

See: \_majorProtocolVersion + +

getMinorProtocolVersion() : \(int | \NULL)

inherited

Get the minor protocol version that is in use.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()\Zend_Gdata_App_FeedSourceParent::getMinorProtocolVersion()\Zend_Gdata_App_Feed::getMinorProtocolVersion()\Zend_Gdata_Feed::getMinorProtocolVersion()

Returns

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

Details

See: \_minorProtocolVersion + +

getNextFeed() : mixed | null

inherited

Retrieve the next set of results from this feed.

Inherited from: + \Zend_Gdata_App_Feed::getNextFeed()\Zend_Gdata_Feed::getNextFeed()

Returns

Type	Description
mixed \| null	Returns the next set of results as a feed of the same + class as this feed, or null if no results exist.

Throws

Exception	Description
\Zend_Gdata_App_Exception

getNextLink() : \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

Type	Description
\Zend_Gdata_App_Extension_Link	The link, or null if not found

getPreviousFeed() : mixed | null

inherited

Retrieve the previous set of results from this feed.

Inherited from: + \Zend_Gdata_App_Feed::getPreviousFeed()\Zend_Gdata_Feed::getPreviousFeed()

Returns

Type	Description
mixed \| null	Returns the previous set of results as a feed of + the same class as this feed, or null if no results exist.

Throws

Exception	Description
\Zend_Gdata_App_Exception

getPreviousLink() : \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

Type	Description
\Zend_Gdata_App_Extension_Link	The link, or null if not found

getRights() : \Zend_Gdata_AppExtension_Rights

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getRights()\Zend_Gdata_App_FeedSourceParent::getRights()\Zend_Gdata_App_Feed::getRights()\Zend_Gdata_Feed::getRights()

Returns

Type	Description
\Zend_Gdata_AppExtension_Rights

getSelfLink() : \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

Type	Description
\Zend_Gdata_App_Extension_Link	The link, or null if not found

getService() : \Zend_Gdata_App | null

inherited

Get the active service instance for this object.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getService()\Zend_Gdata_App_FeedSourceParent::getService()\Zend_Gdata_App_Feed::getService()\Zend_Gdata_Feed::getService()

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

Returns

Type	Description
\Zend_Gdata_App \| null	The current service instance, or null if + not set.

getStartIndex() : \Zend_Gdata_Extension_OpenSearchStartIndex | null

inherited

Get the value of the startIndex property.

Inherited from: + \Zend_Gdata_Feed::getStartIndex()

Returns

Type	Description
\Zend_Gdata_Extension_OpenSearchStartIndex \| null	The value of the + startIndex property, or null if unset.

getSubtitle() : \Zend_Gdata_AppExtension_Subtitle

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::getSubtitle()\Zend_Gdata_App_Feed::getSubtitle()\Zend_Gdata_Feed::getSubtitle()

Returns

Type	Description
\Zend_Gdata_AppExtension_Subtitle

getText( $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

Name	Type	Description
$trim

Returns

Type	Description
string	Child text node

getTitle() : \Zend_Gdata_App_Extension_Title

inherited

Returns the title of this feed or entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getTitle()\Zend_Gdata_App_FeedSourceParent::getTitle()\Zend_Gdata_App_Feed::getTitle()\Zend_Gdata_Feed::getTitle()

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

Type	Description
\Zend_Gdata_App_Extension_Title

getTitleValue() : string

inherited

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

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getTitleValue()\Zend_Gdata_App_FeedSourceParent::getTitleValue()\Zend_Gdata_App_Feed::getTitleValue()\Zend_Gdata_Feed::getTitleValue()

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

Type	Description
string

getTotalResults() : \Zend_Gdata_Extension_OpenSearchTotalResults | null

inherited

Get the value of the totalResults property.

Inherited from: + \Zend_Gdata_Feed::getTotalResults()

Returns

Type	Description
\Zend_Gdata_Extension_OpenSearchTotalResults \| null	The value of + the totalResults property, or null if unset.

getUpdated() : \Zend_Gdata_App_Extension_Updated

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getUpdated()\Zend_Gdata_App_FeedSourceParent::getUpdated()\Zend_Gdata_App_Feed::getUpdated()\Zend_Gdata_Feed::getUpdated()

Returns

Type	Description
\Zend_Gdata_App_Extension_Updated

getXML() : string

inherited

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

Inherited from: + \Zend_Gdata_App_Base::getXML()\Zend_Gdata_App_FeedEntryParent::getXML()\Zend_Gdata_App_FeedSourceParent::getXML()\Zend_Gdata_App_Feed::getXML()\Zend_Gdata_Feed::getXML()

Returns

Type	Description
string	XML content

getlogo() : \Zend_Gdata_AppExtension_logo

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::getlogo()\Zend_Gdata_App_Feed::getlogo()\Zend_Gdata_Feed::getlogo()

Returns

Type	Description
\Zend_Gdata_AppExtension_logo

key() : mixed

inherited

Required by the Iterator interface.

Inherited from: + \Zend_Gdata_App_Feed::key()\Zend_Gdata_Feed::key()

Returns

Type	Description
mixed	The current row number (starts at 0), or NULL if no rows

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

inherited

Get the full version of a namespace prefix

Inherited from: + \Zend_Gdata_App_FeedEntryParent::lookupNamespace()\Zend_Gdata_App_FeedSourceParent::lookupNamespace()\Zend_Gdata_App_Feed::lookupNamespace()\Zend_Gdata_Feed::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.

+ +

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

Name	Type	Description
$prefix	string	The namespace prefix to lookup.
$majorVersion	integer	The major protocol version in effect. + Defaults to null (auto-select). +
$minorVersion	integer	The minor protocol version in effect. + Defaults to null (auto-select). +

Returns

Type	Description
string

next() : mixed

inherited

Required by the Iterator interface.

Inherited from: + \Zend_Gdata_App_Feed::next()\Zend_Gdata_Feed::next()

Returns

Type	Description
mixed	The next row, or null if no more rows.

offsetExists(int $key) : boolean

inherited

Required by the ArrayAccess interface

Inherited from: + \Zend_Gdata_App_Feed::offsetExists()\Zend_Gdata_Feed::offsetExists()

Parameters

Name	Type	Description
$key	int	The index to check for existence

Returns

Type	Description
boolean

offsetGet(int $key) : void

inherited

Required by the ArrayAccess interface

Inherited from: + \Zend_Gdata_App_Feed::offsetGet()\Zend_Gdata_Feed::offsetGet()

Parameters

Name	Type	Description
$key	int	The index to get

offsetSet(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

Name	Type	Description
$key	int	The index to set
$value	\Zend_Gdata_App_Entry	The value to set

offsetUnset(int $key) : void

inherited

Required by the ArrayAccess interface

Inherited from: + \Zend_Gdata_App_Feed::offsetUnset()\Zend_Gdata_Feed::offsetUnset()

Parameters

Name	Type	Description
$key	int	The index to set

registerAllNamespaces(array $namespaceArray) : void

inherited

Add an array of namespaces to the registered list.

Inherited from: + \Zend_Gdata_App_Base::registerAllNamespaces()\Zend_Gdata_App_FeedEntryParent::registerAllNamespaces()\Zend_Gdata_App_FeedSourceParent::registerAllNamespaces()\Zend_Gdata_App_Feed::registerAllNamespaces()\Zend_Gdata_Feed::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()

Parameters

Name	Type	Description
$namespaceArray	array	An array of namespaces.

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

inherited

Add a namespace and prefix to the registered list

Inherited from: + \Zend_Gdata_App_Base::registerNamespace()\Zend_Gdata_App_FeedEntryParent::registerNamespace()\Zend_Gdata_App_FeedSourceParent::registerNamespace()\Zend_Gdata_App_Feed::registerNamespace()\Zend_Gdata_Feed::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().

Parameters

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

rewind() : void

inherited

Required by the Iterator interface.

Inherited from: + \Zend_Gdata_App_Feed::rewind()\Zend_Gdata_Feed::rewind()

saveXML() : string

inherited

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

Inherited from: + \Zend_Gdata_App_Base::saveXML()\Zend_Gdata_App_FeedEntryParent::saveXML()\Zend_Gdata_App_FeedSourceParent::saveXML()\Zend_Gdata_App_Feed::saveXML()\Zend_Gdata_Feed::saveXML()

Returns

Type	Description
string	XML content

setAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Sets the list of the authors of this feed/entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setAuthor()\Zend_Gdata_App_FeedSourceParent::setAuthor()\Zend_Gdata_App_Feed::setAuthor()\Zend_Gdata_Feed::setAuthor()

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

Parameters

Name	Type	Description
$value	array

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setCategory(array $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Sets the array of categories that classify this feed/entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setCategory()\Zend_Gdata_App_FeedSourceParent::setCategory()\Zend_Gdata_App_Feed::setCategory()\Zend_Gdata_Feed::setCategory()

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

Parameters

Name	Type	Description
$value	array	Array of Zend_Gdata_App_Extension_Category

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setContributor(array $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Sets the array of contributors to this feed/entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setContributor()\Zend_Gdata_App_FeedSourceParent::setContributor()\Zend_Gdata_App_Feed::setContributor()\Zend_Gdata_Feed::setContributor()

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

Parameters

Name	Type	Description
$value	array

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setEntry(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

Name	Type	Description
$value	array	The array of Zend_Gdata_App_Entry elements

Returns

Type	Description
\Zend_Gdata_App_Feed	Provides a fluent interface

setEtag(string | null $value) : \Zend_Gdata_App_Entry

inherited

Set the Etag for the current entry to $value.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setEtag()\Zend_Gdata_App_FeedSourceParent::setEtag()\Zend_Gdata_App_Feed::setEtag()\Zend_Gdata_Feed::setEtag()

Setting $value to null +unsets the Etag.

Parameters

Name	Type	Description
$value	string \| null

Returns

Type	Description
\Zend_Gdata_App_Entry	Provides a fluent interface

setExtensionAttributes(array $value) : \Zend_Gdata_App_Base

inherited

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

Parameters

Name	Type	Description
$value	array	All extension attributes

Returns

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

inherited

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

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

Parameters

Name	Type	Description
$value	array	All extension elements

Returns

Type	Description
\Zend_Gdata_App_Base	Returns an object of the same type as 'this' to provide a fluent interface.

setGenerator(\Zend_Gdata_App_Extension_Generator $value) : \Zend_Gdata_App_FeedSourceParent

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::setGenerator()\Zend_Gdata_App_Feed::setGenerator()\Zend_Gdata_Feed::setGenerator()

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Extension_Generator

Returns

Type	Description
\Zend_Gdata_App_FeedSourceParent	Provides a fluent interface

setHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedSourceParent

inherited

Set the HTTP client instance

Inherited from: + \Zend_Gdata_App_FeedSourceParent::setHttpClient()\Zend_Gdata_App_Feed::setHttpClient()\Zend_Gdata_Feed::setHttpClient()

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

Parameters

Name	Type	Description
$httpClient	\Zend_Http_Client

Returns

Type	Description
\Zend_Gdata_App_FeedSourceParent	Provides a fluent interface

setIcon(\Zend_Gdata_App_Extension_Icon $value) : \Zend_Gdata_App_FeedSourceParent

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::setIcon()\Zend_Gdata_App_Feed::setIcon()\Zend_Gdata_Feed::setIcon()

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Extension_Icon

Returns

Type	Description
\Zend_Gdata_App_FeedSourceParent	Provides a fluent interface

setId(\Zend_Gdata_App_Extension_Id $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setId()\Zend_Gdata_App_FeedSourceParent::setId()\Zend_Gdata_App_Feed::setId()\Zend_Gdata_Feed::setId()

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Extension_Id

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setItemsPerPage(\Zend_Gdata_Extension_OpenSearchItemsPerPage | null $value) : \Zend_Gdata_Feed

inherited

Set the itemsPerPage property.

Inherited from: + \Zend_Gdata_Feed::setItemsPerPage()

Parameters

Name	Type	Description
$value	\Zend_Gdata_Extension_OpenSearchItemsPerPage \| null	The + value for the itemsPerPage property. Use nul to unset.

Returns

Type	Description
\Zend_Gdata_Feed	Provides a fluent interface.

setLink(array $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setLink()\Zend_Gdata_App_FeedSourceParent::setLink()\Zend_Gdata_App_Feed::setLink()\Zend_Gdata_Feed::setLink()

Parameters

Name	Type	Description
$value	array	The array of Zend_Gdata_App_Extension_Link elements

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setMajorProtocolVersion(\(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

Name	Type	Description
$value	\(int \| \NULL)	The major protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_majorProtocolVersion + +

setMinorProtocolVersion(\(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

Name	Type	Description
$value	\(int \| \NULL)	The minor protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_minorProtocolVersion + +

setRights(\Zend_Gdata_App_Extension_Rights $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setRights()\Zend_Gdata_App_FeedSourceParent::setRights()\Zend_Gdata_App_Feed::setRights()\Zend_Gdata_Feed::setRights()

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Extension_Rights

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setService(\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

Name	Type	Description
$instance	\Zend_Gdata_App	The new service instance.

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface.

setStartIndex(\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

Name	Type	Description
$value	\Zend_Gdata_Extension_OpenSearchStartIndex \| null	The value + for the startIndex property. Use null to unset.

Returns

Type	Description
\Zend_Gdata_Feed	Provides a fluent interface.

setSubtitle(\Zend_Gdata_App_Extension_Subtitle $value) : \Zend_Gdata_App_FeedSourceParent

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::setSubtitle()\Zend_Gdata_App_Feed::setSubtitle()\Zend_Gdata_Feed::setSubtitle()

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Extension_Subtitle

Returns

Type	Description
\Zend_Gdata_App_FeedSourceParent	Provides a fluent interface

setText(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

Name	Type	Description
$value	string	Child text node

Returns

Type	Description
\Zend_Gdata_App_Base	Returns an object of the same type as 'this' to provide a fluent interface.

setTitle(\Zend_Gdata_App_Extension_Title $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Returns the title of this feed or entry.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setTitle()\Zend_Gdata_App_FeedSourceParent::setTitle()\Zend_Gdata_App_Feed::setTitle()\Zend_Gdata_Feed::setTitle()

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

Name	Type	Description
$value	\Zend_Gdata_App_Extension_Title

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setTotalResults(\Zend_Gdata_Extension_OpenSearchTotalResults | null $value) : \Zend_Gdata_Feed

inherited

Set the value of the totalResults property.

Inherited from: + \Zend_Gdata_Feed::setTotalResults()

Parameters

Name	Type	Description
$value	\Zend_Gdata_Extension_OpenSearchTotalResults \| null	The + value of the totalResults property. Use null to unset.

Returns

Type	Description
\Zend_Gdata_Feed	Provides a fluent interface.

setUpdated(\Zend_Gdata_App_Extension_Updated $value) : \Zend_Gdata_App_FeedEntryParent

inherited

Inherited from: + \Zend_Gdata_App_FeedEntryParent::setUpdated()\Zend_Gdata_App_FeedSourceParent::setUpdated()\Zend_Gdata_App_Feed::setUpdated()\Zend_Gdata_Feed::setUpdated()

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Extension_Updated

Returns

Type	Description
\Zend_Gdata_App_FeedEntryParent	Provides a fluent interface

setlogo(\Zend_Gdata_App_Extension_logo $value) : \Zend_Gdata_App_FeedSourceParent

inherited

Inherited from: + \Zend_Gdata_App_FeedSourceParent::setlogo()\Zend_Gdata_App_Feed::setlogo()\Zend_Gdata_Feed::setlogo()

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Extension_logo

Returns

Type	Description
\Zend_Gdata_App_FeedSourceParent	Provides a fluent interface

takeAttributeFromDOM(\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

Name	Type	Description
$attribute	\DOMNode	The DOMNode attribute needed to be handled

takeChildFromDOM(\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

Name	Type	Description
$child	\DOMNode	The DOMNode to process

transferFromDOM(\DOMNode $node) : void

inherited

Transfers each child and attribute into member variables.

Inherited from: + \Zend_Gdata_App_Base::transferFromDOM()\Zend_Gdata_App_FeedEntryParent::transferFromDOM()\Zend_Gdata_App_FeedSourceParent::transferFromDOM()\Zend_Gdata_App_Feed::transferFromDOM()\Zend_Gdata_Feed::transferFromDOM()

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

Parameters

Name	Type	Description
$node	\DOMNode	The DOMNode that represents this object's data +

transferFromXML(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

Name	Type	Description
$xml	string	The XML text to parse

valid() : boolean

inherited

Required by the Iterator interface.

Inherited from: + \Zend_Gdata_App_Feed::valid()\Zend_Gdata_Feed::valid()

Returns

Type	Description
boolean	Whether the iteration is valid

Gdata/Books/CollectionFeed.php

\Zend_Gdata_Books_CollectionFeedjump to top

Properties

Methods

\Zend_Gdata_Books_CollectionFeed
jump to top