Abstract class for common functionality in entries and feeds
category | Zend |
---|---|
package | Zend_Gdata |
subpackage | App |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Gdata_App_Base |
__construct($element = null
)
inherited_from | \Zend_Gdata_App_Base::__construct() |
---|
__construct()
__get(string $name)
TODO Remove ability to bypass getFoo() methods??
string
The variable name sought
__isset(string $name)
string
__set(string $name, $val)
Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.
TODO Remove ability to bypass getFoo() methods??
string
__toString() : string
string
The text representation of this object__unset(string $name)
string
encode() : string
Can be overridden by children to provide more complex representations of entries.
string
Encoded string contentflushNamespaceLookupCache()
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
This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetAuthor() : \Zend_Gdata_App_Extension_Author
\Zend_Gdata_App_Extension_Author
getCategory() : array
array
Array of Zend_Gdata_App_Extension_CategorygetContributor() : array
array
An array of Zend_Gdata_App_Extension_ContributorgetDOM(\DOMDocument $doc= null
, $majorVersion= 1
, $minorVersion= null
)
inherited_from | \Zend_Gdata_App_Base::getDOM() |
---|
getDOM(\DOMDocument $doc= null
, $majorVersion= 1
, $minorVersion= null
) : \DOMElement
\DOMDocument
The DOMDocument used to construct DOMElements
\DOMElement
The DOMElement representing this element and all
child properties.getEditLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetEtag() : string | null
string
null
getExtensionAttributes() : array
array
All extension attributesgetExtensionElements() : array
array
All elements not matched to data model classes during parsinggetHttpClient() : \Zend_Http_Client_Abstract
deprecated | Deprecated as of Zend Framework 1.7. Use getService() instead. |
---|
\Zend_Http_Client_Abstract
getId() : \Zend_Gdata_App_Extension_Id
\Zend_Gdata_App_Extension_Id
getLicenseLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
getLink(string $rel = null
) : mixed
string
The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned
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 functiongetMajorProtocolVersion() : \(int | \NULL)
getMinorProtocolVersion() : \(int | \NULL)
getNextLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetPreviousLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetRights() : \Zend_Gdata_AppExtension_Rights
\Zend_Gdata_AppExtension_Rights
getSelfLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetService() : \Zend_Gdata_App | null
\Zend_Gdata_App
null
The current service instance, or null if
not set.getText($trim = true
) : string
string
Child text nodegetTitle() : \Zend_Gdata_App_Extension_Title
\Zend_Gdata_App_Extension_Title
getTitleValue() : string
The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry
string
getUpdated() : \Zend_Gdata_App_Extension_Updated
\Zend_Gdata_App_Extension_Updated
getXML() : string
string
XML contentlookupNamespace(string $prefix, integer $majorVersion= null
, integer $minorVersion= null
) : string
Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.
The current entry or feed's version will be used when performing the namespace lookup unless overridden using $majorVersion and $minorVersion. If the entry/fee has a null version, then the latest protocol version will be used by default.
inherited_from | \Zend_Gdata_App_Base::lookupNamespace() |
---|
string
The namespace prefix to lookup.
integer
The major protocol version in effect. Defaults to null (auto-select).
integer
The minor protocol version in effect. Defaults to null (auto-select).
string
lookupNamespace(string $prefix, integer $majorVersion= 1
, integer $minorVersion= null
) : string
Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.
string
The namespace prefix to lookup.
integer
The major protocol version in effect. Defaults to '1'.
integer
The minor protocol version in effect. Defaults to null (use latest).
string
registerAllNamespaces(array $namespaceArray) : void
Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()
array
An array of namespaces.
registerNamespace(string $prefix, string $namespaceUri, integer $majorVersion= 1
, integer $minorVersion= 0
) : void
Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().
WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().
string
The namespace prefix
string
The full namespace URI
integer
The major protocol version in effect. Defaults to '1'.
integer
The minor protocol version in effect. Defaults to null (use latest).
saveXML() : string
string
XML contentsetAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent
array
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetCategory(array $value) : \Zend_Gdata_App_FeedEntryParent
array
Array of Zend_Gdata_App_Extension_Category
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetContributor(array $value) : \Zend_Gdata_App_FeedEntryParent
array
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetEtag(string|null $value) : \Zend_Gdata_App_Entry
string
null
\Zend_Gdata_App_Entry
Provides a fluent interfacesetExtensionAttributes(array $value) : \Zend_Gdata_App_Base
array
All extension attributes
\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
array
All extension elements
\Zend_Gdata_App_Base
Returns an object of the same type as 'this' to provide a fluent interface.setHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedEntryParent
Sets the HTTP client object to use for retrieving the feed.
deprecated | Deprecated as of Zend Framework 1.7. Use setService() instead. |
---|
\Zend_Http_Client
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetId(\Zend_Gdata_App_Extension_Id $value) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App_Extension_Id
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetLink(array $value) : \Zend_Gdata_App_FeedEntryParent
array
The array of Zend_Gdata_App_Extension_Link elements
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetMajorProtocolVersion(\(int|\NULL) $value)
setMinorProtocolVersion(\(int|\NULL) $value)
setRights(\Zend_Gdata_App_Extension_Rights $value) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App_Extension_Rights
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App
The new service instance.
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interface.setText(string $value) : \Zend_Gdata_App_Base
string
Child text node
\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
\Zend_Gdata_App_Extension_Title
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetUpdated(\Zend_Gdata_App_Extension_Updated $value) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App_Extension_Updated
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacetransferFromDOM(\DOMNode $node)
This is called when XML is received over the wire and the data model needs to be built to represent this XML.
\DOMNode
The DOMNode that represents this object's data
transferFromXML(string $xml)
string
The XML text to parse
takeAttributeFromDOM(\DOMNode $attribute)
\DOMNode
The DOMNode attribute needed to be handled
takeChildFromDOM(\DOMNode $child)
inherited_from | \Zend_Gdata_App_Base::takeChildFromDOM() |
---|
takeChildFromDOM(\DOMNode $child)
\DOMNode
The DOMNode needed to be handled
$_category
array()
$_contributor
array()
$_etag : string | null
NULL
$_extensionAttributes : array
array()
$_extensionElements : array
array()
$_id
null
$_link
array()
$_majorProtocolVersion
1
$_minorProtocolVersion
null
$_namespaceLookupCache : array
array()
$_namespaces : array
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')))
$_rights
null
$_rootElement : string
null
$_rootNamespace : string
'atom'
$_rootNamespaceURI : string
null
$_text : string
null
$_title
null
$_updated
null