Gdata/App/FeedSourceParent.php

Show: inherited
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 [email protected] 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
App  
Version
$Id: FeedSourceParent.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_App_FeedSourceParent

Package: Zend\Gdata\App

Atom feed class

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

Properties

Propertyprotected$_author = array()
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_author  
Propertyprotected$_category = array()
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_category  
Propertyprotected$_contributor = array()
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_contributor  
Propertyprotectedstring $_entryClassName = 'Zend_Gdata_App_Entry'

The classname for individual feed elements.

Default value'Zend_Gdata_App_Entry'Details
Type
string
Propertyprotectedstring|null $_etag = NULL
inherited

The HTTP ETag associated with this entry.

Inherited from: \Zend_Gdata_App_FeedEntryParent::$$_etag

Used for optimistic concurrency in protoco v2 or greater.

Default valueNULLDetails
Type
string | null
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_etag  
Propertyprotectedarray $_extensionAttributes = array()
inherited<p>Leftover attributes which were not handled</p>

Inherited from: \Zend_Gdata_App_Base::$$_extensionAttributes\Zend_Gdata_App_FeedEntryParent::$$_extensionAttributes
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_extensionAttributes  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_extensionAttributes  
Propertyprotectedarray $_extensionElements = array()
inherited<p>Leftover elements which were not handled</p>

Inherited from: \Zend_Gdata_App_Base::$$_extensionElements\Zend_Gdata_App_FeedEntryParent::$$_extensionElements
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_extensionElements  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_extensionElements  
Propertyprotected$_generator = null
Default valuenullDetails
Type
n/a
Propertyprotected$_icon = null
Default valuenullDetails
Type
n/a
Propertyprotected$_id = null
inheritedInherited from: \Zend_Gdata_App_FeedEntryParent::$$_id
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_id  
Propertyprotected$_link = array()
inheritedInherited from: \Zend_Gdata_App_FeedEntryParent::$$_link
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_link  
Propertyprotected$_logo = null
Default valuenullDetails
Type
n/a
Propertyprotected$_majorProtocolVersion = 1
inherited

Indicates the major protocol version that should be used.

Inherited from: \Zend_Gdata_App_FeedEntryParent::$$_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  
See
\global\setMajorProtocolVersion()  
See
\global\getMajorProtocolVersion()  
Propertyprotected$_minorProtocolVersion = null
inherited

Indicates the minor protocol version that should be used.

Inherited from: \Zend_Gdata_App_FeedEntryParent::$$_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  
See
\global\setMinorProtocolVersion()  
See
\global\getMinorProtocolVersion()  
Propertyprotectedarray $_namespaceLookupCache = array()
staticinherited<p>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().</p>

Inherited from: \Zend_Gdata_App_Base::$$_namespaceLookupCache\Zend_Gdata_App_FeedEntryParent::$$_namespaceLookupCache
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_namespaceLookupCache  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_namespaceLookupCache  
Propertyprotectedarray $_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

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  
See
\global\lookupNamespace()  
See
\global\registerNamespace()  
See
\global\registerAllNamespaces()  
Propertyprotected$_rights = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_rights  
Propertyprotectedstring $_rootElement = null

Root XML element for Atom entries.

Default valuenullDetails
Type
string
Propertyprotectedstring $_rootNamespace = 'atom'
inherited<p>The XML namespace prefix</p>

Inherited from: \Zend_Gdata_App_Base::$$_rootNamespace\Zend_Gdata_App_FeedEntryParent::$$_rootNamespace
Default value'atom'Details
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_rootNamespace  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_rootNamespace  
Propertyprotectedstring $_rootNamespaceURI = null
inherited<p>The XML namespace URI - takes precedence over lookup up the corresponding URI for $_rootNamespace</p>

Inherited from: \Zend_Gdata_App_Base::$$_rootNamespaceURI\Zend_Gdata_App_FeedEntryParent::$$_rootNamespaceURI
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_rootNamespaceURI  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_rootNamespaceURI  
Propertyprotected$_service = null
inherited

Service instance used to make network requests.

Inherited from: \Zend_Gdata_App_FeedEntryParent::$$_service
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_service  
See
\global\setService(),  
Propertyprotected$_subtitle = null
Default valuenullDetails
Type
n/a
Propertyprotectedstring $_text = null
inherited<p>XML child text node content</p>

Inherited from: \Zend_Gdata_App_Base::$$_text\Zend_Gdata_App_FeedEntryParent::$$_text
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_text  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_text  
Propertyprotected$_title = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_title  
Propertyprotected$_updated = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_updated  

Methods

methodpublic__construct( $element = null) : void
inherited

Constructs a Feed or Entry

Inherited from: \Zend_Gdata_App_FeedEntryParent::__construct()
Parameters
Name Type Description
$element
methodpublic__get(string $var) : mixed

Make accessing some individual elements of the feed easier.

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

Returns
Type Description
mixed
methodpublic__isset(string $name) : void
Parameters
Name Type Description
$name string
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()

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
methodpublic__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()
Returns
Type Description
string The text representation of this object
methodpublic__unset(string $name) : void
Parameters
Name Type Description
$name string
methodpublicencode() : string

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

Returns
Type Description
string Encoded 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()

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

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicgetContributor() : array
inherited

Returns the array of contributors to this feed/entry.

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicgetDOM(\DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null) : \DOMElement

Retrieves a DOMElement which corresponds to this element and all child properties.

This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Parameters
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The DOMElement representing this element and all child properties.
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()

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
methodpublicgetEtag() : string | null
inherited

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getEtag()
Returns
Type Description
string | null
methodpublicgetExtensionAttributes() : 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()

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
methodpublicgetExtensionElements() : 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()
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
inherited

Gets the HTTP client object.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getHttpClient()

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

Returns
Type Description
\Zend_Http_Client_Abstract
methodpublicgetIcon() : \Zend_Gdata_AppExtension_Icon

Returns
Type Description
\Zend_Gdata_AppExtension_Icon
methodpublicgetId() : \Zend_Gdata_App_Extension_Id
inherited

Inherited from: \Zend_Gdata_App_FeedEntryParent::getId()
Returns
Type Description
\Zend_Gdata_App_Extension_Id
methodpublicgetLicenseLink() : \Zend_Gdata_App_Extension_Link
Returns
Type Description
\Zend_Gdata_App_Extension_Link
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()

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
methodpublicgetMajorProtocolVersion() : \(int | \NULL)
inherited

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
\global\_majorProtocolVersion  
methodpublicgetMinorProtocolVersion() : \(int | \NULL)
inherited

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
\global\_minorProtocolVersion  
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()

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

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

Get the active service instance for this object.

Inherited from: \Zend_Gdata_App_FeedEntryParent::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.
methodpublicgetSubtitle() : \Zend_Gdata_AppExtension_Subtitle

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

Returns the title of this feed or entry.

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicgetTitleValue() : string
inherited

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
methodpublicgetXML() : 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()
Returns
Type Description
string XML content
methodpublicgetlogo() : \Zend_Gdata_AppExtension_logo

Returns
Type Description
\Zend_Gdata_AppExtension_logo
methodpubliclookupNamespace(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()

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

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
inherited

Add a namespace and prefix to the registered list

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

methodpublicsaveXML() : 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()
Returns
Type Description
string XML content
methodpublicsetAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent
inherited

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicsetCategory(array $value) : \Zend_Gdata_App_FeedEntryParent
inherited

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicsetContributor(array $value) : \Zend_Gdata_App_FeedEntryParent
inherited

Sets the array of contributors to this feed/entry.

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

Set the Etag for the current entry to $value.

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

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

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

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
inherited

Inherited from: \Zend_Gdata_App_FeedEntryParent::setId()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Id
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetLink(array $value) : \Zend_Gdata_App_FeedEntryParent
inherited

Inherited from: \Zend_Gdata_App_FeedEntryParent::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
methodpublicsetMajorProtocolVersion(\(int | \NULL) $value) : void
inherited

Set the major protocol version that should be used.

Inherited from: \Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()

Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Parameters
Name Type Description
$value \(int | \NULL)

The major protocol version to use.

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

Set the minor protocol version that should be used.

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

Parameters
Name Type Description
$value \(int | \NULL)

The minor protocol version to use.

Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\global\_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.

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

Returns the title of this feed or entry.

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

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

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

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

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

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

methodpublictransferFromDOM(\DOMNode $node) : void
inherited

Transfers each child and attribute into member variables.

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

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

Documentation was generated by phpDocumentor 2.0.0a8.