Gdata/App/FeedEntryParent.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
App  
Version
$Id: FeedEntryParent.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_App_FeedEntryParent

Package: Zend\Gdata\App
Abstract class for common functionality in entries and feeds
Parent(s)
\Zend_Gdata_App_Base
Children
\Zend_Gdata_App_FeedSourceParent
\Zend_Gdata_App_Entry
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_author = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_category = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_contributor = array()
Default valuearray()Details
Type
n/a
>VPropertyprotectedstring|null $_etag = NULL
The HTTP ETag associated with this entry.

Used for optimistic concurrency in protoco v2 or greater.

Default valueNULLDetails
Type
string | null
>VPropertyprotectedarray $_extensionAttributes = array()
inherited

Leftover attributes which were not handled

Inherited from: \Zend_Gdata_App_Base::$$_extensionAttributes
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_extensionAttributes  
>VPropertyprotectedarray $_extensionElements = array()
inherited

Leftover elements which were not handled

Inherited from: \Zend_Gdata_App_Base::$$_extensionElements
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_extensionElements  
>VPropertyprotected$_id = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_link = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_majorProtocolVersion = 1
Indicates the major protocol version that should be used.

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

Default value1Details
Type
n/a
See
\setMajorProtocolVersion()  
See
\getMajorProtocolVersion()  
>VPropertyprotected$_minorProtocolVersion = null
Indicates the minor protocol version that should be used.

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

Default valuenullDetails
Type
n/a
See
\setMinorProtocolVersion()  
See
\getMinorProtocolVersion()  
>VPropertyprotectedarray $_namespaceLookupCache = array()
staticinherited

Memoized results from calls to lookupNamespace() to avoid expensive calls to getGreatestBoundedValue(). The key is in the form 'prefix-majorVersion-minorVersion', and the value is the output from getGreatestBoundedValue().

Inherited from: \Zend_Gdata_App_Base::$$_namespaceLookupCache
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_namespaceLookupCache  
>VPropertyprotectedarray $_namespaces = array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))
inherited
List of namespaces, as a three-dimensional array.
Inherited from: \Zend_Gdata_App_Base::$$_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  
See
\lookupNamespace()  
See
\registerNamespace()  
See
\registerAllNamespaces()  
>VPropertyprotected$_rights = null
Default valuenullDetails
Type
n/a
>VPropertyprotectedstring $_rootElement = null
inherited

The XML element name, including prefix if desired

Inherited from: \Zend_Gdata_App_Base::$$_rootElement
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_rootElement  
>VPropertyprotectedstring $_rootNamespace = 'atom'
inherited

The XML namespace prefix

Inherited from: \Zend_Gdata_App_Base::$$_rootNamespace
Default value'atom'Details
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_rootNamespace  
>VPropertyprotectedstring $_rootNamespaceURI = null
inherited

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

Inherited from: \Zend_Gdata_App_Base::$$_rootNamespaceURI
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_App_Base::$$_rootNamespaceURI  
>VPropertyprotected$_service = null
Service instance used to make network requests.
Default valuenullDetails
Type
n/a
See
getService()  
>VPropertyprotectedstring $_text = null
inherited

XML child text node content

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

Methods

methodpublic__construct( $element = null) : void

Constructs a Feed or Entry

Parameters
NameTypeDescription
$element
methodpublic__get(string $name) : void
inherited

Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.

Inherited from: \Zend_Gdata_App_Base::__get()

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring

The variable name sought

methodpublic__isset(string $name) : void
inherited

Magic __isset method

Inherited from: \Zend_Gdata_App_Base::__isset()
Parameters
NameTypeDescription
$namestring
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()

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

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring
$val
methodpublic__toString() : string
inherited

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

Inherited from: \Zend_Gdata_App_Base::__toString()
Returns
TypeDescription
stringThe text representation of this object
methodpublic__unset(string $name) : void
inherited

Magic __unset method

Inherited from: \Zend_Gdata_App_Base::__unset()
Parameters
NameTypeDescription
$namestring
methodpublicencode() : string
inherited

Alias for saveXML()

Inherited from: \Zend_Gdata_App_Base::encode()

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

Returns
TypeDescription
stringEncoded string content
methodpublicflushNamespaceLookupCache() : void
staticinherited

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

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

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

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

Returns
TypeDescription
arrayArray 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

Returns
TypeDescription
arrayAn 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
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
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'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetEtag() : string | null

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

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

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

Returns
TypeDescription
arrayAll extension attributes
methodpublicgetExtensionElements() : array
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()
Returns
TypeDescription
arrayAll elements not matched to data model classes during parsing
methodpublicgetHttpClient() : \Zend_Http_Client_Abstract

Gets the HTTP client object.

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

Returns
TypeDescription
\Zend_Http_Client_Abstract
Details
Deprecated
Deprecated as of Zend Framework 1.7. Use getService() instead.  
methodpublicgetLicenseLink() : \Zend_Gdata_App_Extension_Link

Returns
TypeDescription
\Zend_Gdata_App_Extension_Link
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'.

Parameters
NameTypeDescription
$relstring

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

Returns
TypeDescription
mixedEither a single Zend_Gdata_App_Extension_link element, an array of the same or null is returned depending on the rel value supplied as the argument to this function
methodpublicgetMajorProtocolVersion() : \(int | \NULL)

Get the major protocol version that is in use.

Returns
TypeDescription
\(int | \NULL)The major protocol version in use.
Details
See
\_majorProtocolVersion  
methodpublicgetMinorProtocolVersion() : \(int | \NULL)

Get the minor protocol version that is in use.

Returns
TypeDescription
\(int | \NULL)The major protocol version in use, or NULL if no minor version is specified.
Details
See
\_minorProtocolVersion  
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'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
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'.

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

Returns
TypeDescription
\Zend_Gdata_AppExtension_Rights
methodpublicgetSelfLink() : \Zend_Gdata_App_Extension_Link

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

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe 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().

Returns
TypeDescription
\Zend_Gdata_App | nullThe current service instance, or null if not set.
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()
Parameters
NameTypeDescription
$trim
Returns
TypeDescription
stringChild 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

Returns
TypeDescription
\Zend_Gdata_App_Extension_Title
methodpublicgetTitleValue() : string

Returns a string representation of 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

Returns
TypeDescription
string
methodpublicgetXML() : string
inherited

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

Inherited from: \Zend_Gdata_App_Base::getXML()
Returns
TypeDescription
stringXML content
methodpubliclookupNamespace(string $prefix, integer $majorVersion = null, integer $minorVersion = null) : string

Get the full version of a namespace prefix

Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.

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

Parameters
NameTypeDescription
$prefixstring

The namespace prefix to lookup.

$majorVersioninteger

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

$minorVersioninteger

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

Returns
TypeDescription
string
methodpublicregisterAllNamespaces(array $namespaceArray) : void
inherited

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

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

Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().

WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().

Parameters
NameTypeDescription
$prefixstring

The namespace prefix

$namespaceUristring

The full namespace URI

$majorVersioninteger

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

$minorVersioninteger

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

methodpublicsaveXML() : string
inherited

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

Inherited from: \Zend_Gdata_App_Base::saveXML()
Returns
TypeDescription
stringXML 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

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides 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.

Parameters
NameTypeDescription
$valuearray

Array of Zend_Gdata_App_Extension_Category

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

Sets the array of contributors to this feed/entry.

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

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetEtag(string | null $value) : \Zend_Gdata_App_Entry

Set the Etag for the current entry to $value.

Setting $value to null unsets the Etag.

Parameters
NameTypeDescription
$valuestring | null
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetExtensionAttributes(array $value) : \Zend_Gdata_App_Base
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()

Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string); This can be used to add arbitrary attributes to any data model element

Parameters
NameTypeDescription
$valuearray

All extension attributes

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetExtensionElements(array $value) : \Zend_Gdata_App_Base
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()

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

Parameters
NameTypeDescription
$valuearray

All extension elements

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

Set the HTTP client instance

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

Parameters
NameTypeDescription
$httpClient\Zend_Http_Client
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
Details
Deprecated
Deprecated as of Zend Framework 1.7. Use setService() instead.  
methodpublicsetId(\Zend_Gdata_App_Extension_Id $value) : \Zend_Gdata_App_FeedEntryParent

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

Parameters
NameTypeDescription
$valuearray

The array of Zend_Gdata_App_Extension_Link elements

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

Set the major protocol version that should be used.

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

Parameters
NameTypeDescription
$value\(int | \NULL)

The major protocol version to use.

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

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.

Parameters
NameTypeDescription
$value\(int | \NULL)

The minor protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_minorProtocolVersion  
methodpublicsetRights(\Zend_Gdata_App_Extension_Rights $value) : \Zend_Gdata_App_FeedEntryParent

Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Rights
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent

Set the active service instance for this object.

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

Parameters
NameTypeDescription
$instance\Zend_Gdata_App

The new service instance.

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface.
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()
Parameters
NameTypeDescription
$valuestring

Child text node

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

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

Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Title
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetUpdated(\Zend_Gdata_App_Extension_Updated $value) : \Zend_Gdata_App_FeedEntryParent

Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Updated
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides 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()

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

Parameters
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

Given a child DOMNode, tries to determine how to map the data into object instance members.

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

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode needed to be handled

methodpublictransferFromDOM(\DOMNode $node) : void
inherited

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
NameTypeDescription
$node\DOMNode

The DOMNode that represents this object's data

methodpublictransferFromXML(string $xml) : void
inherited

Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element).

Inherited from: \Zend_Gdata_App_Base::transferFromXML()

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

Parameters
NameTypeDescription
$xmlstring

The XML text to parse

Documentation was generated by phpDocumentor 2.0.0a12.