API Documentation

Gdata/Geo/Feed.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Geo  
version
$Id: Feed.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Gdata_Geo_Feed

Feed for Gdata Geographic data entries.

Extends from
\Zend_Gdata_Feed
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Geo  

Properties

Propertyprotectedstring  $_entryClassName= 'Zend_Gdata_Geo_Entry'

The classname for individual feed elements.

Default valueZend_Gdata_Geo_EntryDetails
Type
string

Methods

methodpublic__construct(  $element = null ) : void

Constructs a Feed or Entry

Parameters
Name Type Description
$element
methodpublic__get( string $var ) : mixed

Make accessing some individual elements of the feed easier.

Inherited from: \Zend_Gdata_App_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
methodpublicaddEntry( \Zend_Gdata_App_Entry $value ) : \Zend_Gdata_App_Feed

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

Inherited from: \Zend_Gdata_App_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
methodpubliccount( ) : integer

Get the number of entries in this feed object.

Inherited from: \Zend_Gdata_App_Feed::count()
Returns
Type Description
integer Entry count.
methodpubliccurrent( ) : mixed

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::current()
Returns
Type Description
mixed The current row, or null if no rows.
methodpublicencode( ) : string

Alias for saveXML()

Inherited from: \Zend_Gdata_App_Base::encode()

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

Returns
Type Description
string Encoded string content
methodpublicflushNamespaceLookupCache( ) : void
static

Flush namespace lookup cache.

Inherited from: \Zend_Gdata_App_Base::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().

methodpublicgetAlternateLink( ) : \Zend_Gdata_App_Extension_Link

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getAlternateLink()

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
methodpublicgetCategory( ) : array

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getCategory()
Returns
Type Description
array Array of Zend_Gdata_App_Extension_Category
methodpublicgetContributor( ) : array

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getContributor()
Returns
Type Description
array An array of Zend_Gdata_App_Extension_Contributor
methodpublicgetDOM( \DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null ) : \DOMElement

Retrieves the DOM model representing this object and all children

Inherited from: \Zend_Gdata_Feed::getDOM()
Parameters
Name Type Description
$doc \DOMDocument
$majorVersion
$minorVersion
Returns
Type Description
\DOMElement
methodpublicgetEditLink( ) : \Zend_Gdata_App_Extension_Link

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource. This link is in the atom feed/entry as an atom:link with a rel attribute value of 'edit'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getEditLink()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetEntry( ) : array

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

Inherited from: \Zend_Gdata_App_Feed::getEntry()
Returns
Type Description
array Zend_Gdata_App_Entry array
methodpublicgetEtag( ) : string|null

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getEtag()
Returns
Type Description
stringnull
methodpublicgetExtensionAttributes( ) : array

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

Inherited from: \Zend_Gdata_App_Base::getExtensionAttributes()
Returns
Type Description
array All extension attributes
methodpublicgetExtensionElements( ) : array

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()
Returns
Type Description
array All elements not matched to data model classes during parsing
methodpublicgetGenerator( ) : \Zend_Gdata_AppExtension_Generator
Returns
Type Description
\Zend_Gdata_AppExtension_Generator
methodpublicgetHttpClient( ) : \Zend_Http_Client_Abstract

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getHttpClient()
Returns
Type Description
\Zend_Http_Client_Abstract
Details
deprecated
Deprecated as of Zend Framework 1.7. Use getService() instead.  
methodpublicgetIcon( ) : \Zend_Gdata_AppExtension_Icon
Returns
Type Description
\Zend_Gdata_AppExtension_Icon
methodpublicgetItemsPerPage( ) : \Zend_Gdata_Extension_OpenSearchItemsPerPage|null

Get the value of the itemsPerPage property.

Inherited from: \Zend_Gdata_Feed::getItemsPerPage()
Returns
Type Description
\Zend_Gdata_Extension_OpenSearchItemsPerPagenull The value of the itemsPerPage property, or null if unset.
methodpublicgetLink( string $rel = null ) : mixed

Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element. 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'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getLink()
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
methodpublicgetMajorProtocolVersion( ) : \(int|\NULL)

Get the major protocol version that is in use.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()
Returns
Type Description
\(int\NULL) The major protocol version in use.
Details
see
\_majorProtocolVersion  
methodpublicgetMinorProtocolVersion( ) : \(int|\NULL)

Get the minor protocol version that is in use.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()
Returns
Type Description
\(int\NULL) The major protocol version in use, or NULL if no minor version is specified.
Details
see
\_minorProtocolVersion  
methodpublicgetNextFeed( ) : mixed|null

Retrieve the next set of results from this feed.

Inherited from: \Zend_Gdata_App_Feed::getNextFeed()
Returns
Type Description
mixednull 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
methodpublicgetNextLink( ) : \Zend_Gdata_App_Extension_Link

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. This link is in the atom feed as an atom:link with a rel attribute value of 'next'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getNextLink()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetPreviousFeed( ) : mixed|null

Retrieve the previous set of results from this feed.

Inherited from: \Zend_Gdata_App_Feed::getPreviousFeed()
Returns
Type Description
mixednull 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
methodpublicgetPreviousLink( ) : \Zend_Gdata_App_Extension_Link

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. This link is in the atom feed as an atom:link with a rel attribute value of 'previous'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getPreviousLink()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetRights( ) : \Zend_Gdata_AppExtension_Rights
Returns
Type Description
\Zend_Gdata_AppExtension_Rights
methodpublicgetSelfLink( ) : \Zend_Gdata_App_Extension_Link

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()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetService( ) : \Zend_Gdata_App|null

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getService()
Returns
Type Description
\Zend_Gdata_Appnull The current service instance, or null if not set.
methodpublicgetStartIndex( ) : \Zend_Gdata_Extension_OpenSearchStartIndex|null

Get the value of the startIndex property.

Inherited from: \Zend_Gdata_Feed::getStartIndex()
Returns
Type Description
\Zend_Gdata_Extension_OpenSearchStartIndexnull The value of the startIndex property, or null if unset.
methodpublicgetSubtitle( ) : \Zend_Gdata_AppExtension_Subtitle
Returns
Type Description
\Zend_Gdata_AppExtension_Subtitle
methodpublicgetText(  $trim = true ) : string

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()
Parameters
Name Type Description
$trim
Returns
Type Description
string Child text node
methodpublicgetTitle( ) : \Zend_Gdata_App_Extension_Title

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getTitle()
Returns
Type Description
\Zend_Gdata_App_Extension_Title
methodpublicgetTitleValue( ) : string

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicgetTotalResults( ) : \Zend_Gdata_Extension_OpenSearchTotalResults|null

Get the value of the totalResults property.

Inherited from: \Zend_Gdata_Feed::getTotalResults()
Returns
Type Description
\Zend_Gdata_Extension_OpenSearchTotalResultsnull The value of the totalResults property, or null if unset.
methodpublicgetXML( ) : string

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

Inherited from: \Zend_Gdata_App_Base::getXML()
Returns
Type Description
string XML content
methodpublicgetlogo( ) : \Zend_Gdata_AppExtension_logo
Returns
Type Description
\Zend_Gdata_AppExtension_logo
methodpublickey( ) : mixed

Required by the Iterator interface.

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

Get the full version of a namespace prefix

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicnext( ) : mixed

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::next()
Returns
Type Description
mixed The next row, or null if no more rows.
methodpublicoffsetExists( int $key ) : boolean

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetExists()
Parameters
Name Type Description
$key int The index to check for existence
Returns
Type Description
boolean
methodpublicoffsetGet( int $key ) : void

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetGet()
Parameters
Name Type Description
$key int The index to get
methodpublicoffsetSet( int $key, \Zend_Gdata_App_Entry $value ) : void

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetSet()
Parameters
Name Type Description
$key int The index to set
$value \Zend_Gdata_App_Entry The value to set
methodpublicoffsetUnset( int $key ) : void

Required by the ArrayAccess interface

Inherited from: \Zend_Gdata_App_Feed::offsetUnset()
Parameters
Name Type Description
$key int The index to set
methodpublicregisterAllNamespaces( array $namespaceArray ) : void

Add an array of namespaces to the registered list.

Inherited from: \Zend_Gdata_App_Base::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.
methodpublicregisterNamespace( string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0 ) : void

Add a namespace and prefix to the registered list

Inherited from: \Zend_Gdata_App_Base::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).

methodpublicrewind( ) : void

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::rewind()
methodpublicsaveXML( ) : string

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

Inherited from: \Zend_Gdata_App_Base::saveXML()
Returns
Type Description
string XML content
methodpublicsetAuthor( array $value ) : \Zend_Gdata_App_FeedEntryParent

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::setAuthor()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetCategory( array $value ) : \Zend_Gdata_App_FeedEntryParent

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::setCategory()
Parameters
Name Type Description
$value array Array of Zend_Gdata_App_Extension_Category
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetContributor( array $value ) : \Zend_Gdata_App_FeedEntryParent

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::setContributor()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetEntry( array $value ) : \Zend_Gdata_App_Feed

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

Inherited from: \Zend_Gdata_App_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
methodpublicsetEtag( string|null $value ) : \Zend_Gdata_App_Entry

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::setEtag()
Parameters
Name Type Description
$value string|null
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetExtensionAttributes( array $value ) : \Zend_Gdata_App_Base

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

Inherited from: \Zend_Gdata_App_Base::setExtensionAttributes()
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.
methodpublicsetExtensionElements( array $value ) : \Zend_Gdata_App_Base

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.

Inherited from: \Zend_Gdata_App_Base::setExtensionElements()
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.
methodpublicsetGenerator( \Zend_Gdata_App_Extension_Generator $value ) : \Zend_Gdata_App_FeedSourceParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Generator
Returns
Type Description
\Zend_Gdata_App_FeedSourceParent Provides a fluent interface
methodpublicsetHttpClient( \Zend_Http_Client $httpClient ) : \Zend_Gdata_App_FeedSourceParent

Set the HTTP client instance

Inherited from: \Zend_Gdata_App_FeedSourceParent::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
Details
deprecated
Deprecated as of Zend Framework 1.7. Use setService() instead.  
methodpublicsetIcon( \Zend_Gdata_App_Extension_Icon $value ) : \Zend_Gdata_App_FeedSourceParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Icon
Returns
Type Description
\Zend_Gdata_App_FeedSourceParent Provides a fluent interface
methodpublicsetId( \Zend_Gdata_App_Extension_Id $value ) : \Zend_Gdata_App_FeedEntryParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Id
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetItemsPerPage( \Zend_Gdata_Extension_OpenSearchItemsPerPage|null $value ) : \Zend_Gdata_Feed

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.
methodpublicsetLink( array $value ) : \Zend_Gdata_App_FeedEntryParent
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
methodpublicsetMajorProtocolVersion( \(int|\NULL) $value ) : void

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

Inherited from: \Zend_Gdata_App_Feed::setMajorProtocolVersion()

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  
methodpublicsetMinorProtocolVersion( \(int|\NULL) $value ) : void

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.

Inherited from: \Zend_Gdata_App_Feed::setMinorProtocolVersion()

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  
methodpublicsetRights( \Zend_Gdata_App_Extension_Rights $value ) : \Zend_Gdata_App_FeedEntryParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Rights
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetService( \Zend_Gdata_App $instance ) : \Zend_Gdata_App_FeedEntryParent

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

Inherited from: \Zend_Gdata_App_FeedSourceParent::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.
methodpublicsetStartIndex( \Zend_Gdata_Extension_OpenSearchStartIndex|null $value ) : \Zend_Gdata_Feed

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.
methodpublicsetSubtitle( \Zend_Gdata_App_Extension_Subtitle $value ) : \Zend_Gdata_App_FeedSourceParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Subtitle
Returns
Type Description
\Zend_Gdata_App_FeedSourceParent Provides a fluent interface
methodpublicsetText( string $value ) : \Zend_Gdata_App_Base

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()
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.
methodpublicsetTitle( \Zend_Gdata_App_Extension_Title $value ) : \Zend_Gdata_App_FeedEntryParent

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::setTitle()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Title
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetTotalResults( \Zend_Gdata_Extension_OpenSearchTotalResults|null $value ) : \Zend_Gdata_Feed

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.
methodpublicsetUpdated( \Zend_Gdata_App_Extension_Updated $value ) : \Zend_Gdata_App_FeedEntryParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Updated
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetlogo( \Zend_Gdata_App_Extension_logo $value ) : \Zend_Gdata_App_FeedSourceParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_logo
Returns
Type Description
\Zend_Gdata_App_FeedSourceParent Provides a fluent interface
methodprotectedtakeAttributeFromDOM( \DOMNode $attribute ) : void

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.

Inherited from: \Zend_Gdata_Feed::takeAttributeFromDOM()
Parameters
Name Type Description
$attribute \DOMNode The DOMNode attribute needed to be handled
methodprotectedtakeChildFromDOM( \DOMNode $child ) : void

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()
Parameters
Name Type Description
$child \DOMNode The DOMNode to process
methodpublictransferFromDOM( \DOMNode $node ) : void

Transfers each child and attribute into member variables.

Inherited from: \Zend_Gdata_App_Base::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

methodpublictransferFromXML( string $xml ) : void

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.

Inherited from: \Zend_Gdata_App_Base::transferFromXML()
Parameters
Name Type Description
$xml string The XML text to parse
methodpublicvalid( ) : boolean

Required by the Iterator interface.

Inherited from: \Zend_Gdata_App_Feed::valid()
Returns
Type Description
boolean Whether the iteration is valid
Documentation was generated by DocBlox 0.13.3.