Gdata/Books/Extension/InfoLink.php
inherited
+ Classes
+ 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 + +
- License
- New BSD License + +
- Package
- Zend_Gdata + +
- Subpackage
- Books + +
- Version
- $Id: InfoLink.php 24593 2012-01-05 20:35:02Z matthew $ + +
\Zend_Gdata_Books_Extension_InfoLink
- Parent(s)
- \Zend_Gdata_Books_Extension_BooksLink + < + \Zend_Gdata_App_Extension_Link + < + \Zend_Gdata_App_Extension + < + \Zend_Gdata_App_Base
- Category
- Zend + +
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + +
- License
- New BSD License + +
Properties
array $_extensionAttributes = array()Leftover attributes which were not handled
array()Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_extensionAttributes + +
- Inherited_from
- \Zend_Gdata_App_Extension::$$_extensionAttributes + +
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_extensionAttributes + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_extensionAttributes + +
array $_extensionElements = array()Leftover elements which were not handled
array()Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_extensionElements + +
- Inherited_from
- \Zend_Gdata_App_Extension::$$_extensionElements + +
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_extensionElements + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_extensionElements + +
$_href = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_href + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_href + +
$_hrefLang = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_hrefLang + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_hrefLang + +
$_length = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_length + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_length + +
array $_namespaceLookupCache = array()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().
+array()Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_namespaceLookupCache + +
- Inherited_from
- \Zend_Gdata_App_Extension::$$_namespaceLookupCache + +
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_namespaceLookupCache + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_namespaceLookupCache + +
array $_namespaces = array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))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.
array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))Details- Type
- array
- Inherited_from
- \Zend_Gdata_App_Base::$$_namespaces + +
- Inherited_from
- \Zend_Gdata_App_Extension::$$_namespaces + +
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_namespaces + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_namespaces + +
- See
- \lookupNamespace() + +
- See
- \registerNamespace() + +
- See
- \registerAllNamespaces() + +
$_rel = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_rel + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_rel + +
string $_rootElement = 'link'The XML element name, including prefix if desired
'link'Details- Type
- string
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_rootElement + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_rootElement + +
string $_rootNamespace = 'atom'The XML namespace prefix
'atom'Details- Type
- string
- Inherited_from
- \Zend_Gdata_App_Base::$$_rootNamespace + +
- Inherited_from
- \Zend_Gdata_App_Extension::$$_rootNamespace + +
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_rootNamespace + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_rootNamespace + +
string $_rootNamespaceURI = nullThe XML namespace URI - takes precedence over lookup up the corresponding URI for $_rootNamespace
+nullDetails- Type
- string
- Inherited_from
- \Zend_Gdata_App_Base::$$_rootNamespaceURI + +
- Inherited_from
- \Zend_Gdata_App_Extension::$$_rootNamespaceURI + +
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_rootNamespaceURI + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_rootNamespaceURI + +
string $_text = nullXML child text node content
nullDetails- Type
- string
- Inherited_from
- \Zend_Gdata_App_Base::$$_text + +
- Inherited_from
- \Zend_Gdata_App_Extension::$$_text + +
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_text + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_text + +
$_title = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_title + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_title + +
$_type = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Gdata_App_Extension_Link::$$_type + +
- Inherited_from
- \Zend_Gdata_Books_Extension_BooksLink::$$_type + +
Methods
__construct(string | null $href = null, string | null $rel = null, string | null $type = null, string | null $hrefLang = null, string | null $title = null, string | null $length = null) : voidConstructor for Zend_Gdata_Books_Extension_InfoLink which +Describes an info link
| Name | Type | Description |
|---|---|---|
| $href | string | null | Linked resource URI |
| $rel | string | null | Forward relationship |
| $type | string | null | Resource MIME type |
| $hrefLang | string | null | Resource language |
| $title | string | null | Human-readable resource title + |
| $length | string | null | Resource length in octets |
__get(string $name) : voidMagic 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()\Zend_Gdata_App_Extension::__get()\Zend_Gdata_App_Extension_Link::__get()\Zend_Gdata_Books_Extension_BooksLink::__get()TODO Remove ability to bypass getFoo() methods??
| Name | Type | Description |
|---|---|---|
| $name | string | The variable name sought |
__isset(string $name) : voidMagic __isset method
Inherited from: + \Zend_Gdata_App_Base::__isset()\Zend_Gdata_App_Extension::__isset()\Zend_Gdata_App_Extension_Link::__isset()\Zend_Gdata_Books_Extension_BooksLink::__isset()| Name | Type | Description |
|---|---|---|
| $name | string |
__set(string $name, $val) : voidMagic setter to allow acces like $entry->foo='bar' to call +$entry->setFoo('bar') automatically.
Inherited from: + \Zend_Gdata_App_Base::__set()\Zend_Gdata_App_Extension::__set()\Zend_Gdata_App_Extension_Link::__set()\Zend_Gdata_Books_Extension_BooksLink::__set()Alternatively, if no setFoo() is defined, but a $_foo protected variable +is defined, this is returned.
+ +TODO Remove ability to bypass getFoo() methods??
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $val |
__toString() : stringMagic 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_Extension::__toString()\Zend_Gdata_App_Extension_Link::__toString()\Zend_Gdata_Books_Extension_BooksLink::__toString()| Type | Description |
|---|---|
| string | The text representation of this object |
__unset(string $name) : voidMagic __unset method
Inherited from: + \Zend_Gdata_App_Base::__unset()\Zend_Gdata_App_Extension::__unset()\Zend_Gdata_App_Extension_Link::__unset()\Zend_Gdata_Books_Extension_BooksLink::__unset()| Name | Type | Description |
|---|---|---|
| $name | string |
encode() : stringAlias for saveXML()
Inherited from: + \Zend_Gdata_App_Base::encode()\Zend_Gdata_App_Extension::encode()\Zend_Gdata_App_Extension_Link::encode()\Zend_Gdata_Books_Extension_BooksLink::encode()Can be overridden by children to provide more complex representations +of entries.
| Type | Description |
|---|---|
| string | Encoded string content |
flushNamespaceLookupCache() : voidFlush namespace lookup cache.
Inherited from: + \Zend_Gdata_App_Base::flushNamespaceLookupCache()\Zend_Gdata_App_Extension::flushNamespaceLookupCache()\Zend_Gdata_App_Extension_Link::flushNamespaceLookupCache()\Zend_Gdata_Books_Extension_BooksLink::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().
getDOM(\DOMDocument $doc = null, $majorVersion = 1, $minorVersion = null) : \DOMElementRetrieves a DOMElement which corresponds to this element and all +child properties.
Inherited from: + \Zend_Gdata_App_Extension_Link::getDOM()\Zend_Gdata_Books_Extension_BooksLink::getDOM()This is used to build an entry back into a DOM +and eventually XML text for sending to the server upon updates, or +for application storage/persistence.
| Name | Type | Description |
|---|---|---|
| $doc | \DOMDocument | The DOMDocument used to construct DOMElements |
| $majorVersion | ||
| $minorVersion |
| Type | Description |
|---|---|
| \DOMElement | The DOMElement representing this element and all +child properties. |
getExtensionAttributes() : arrayReturns 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_Extension::getExtensionAttributes()\Zend_Gdata_App_Extension_Link::getExtensionAttributes()\Zend_Gdata_Books_Extension_BooksLink::getExtensionAttributes()Each element of the array +is a hashed array of the format: + array('namespaceUri' => string, 'name' => string, 'value' => string);
| Type | Description |
|---|---|
| array | All extension attributes |
getExtensionElements() : arrayReturns 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_Extension::getExtensionElements()\Zend_Gdata_App_Extension_Link::getExtensionElements()\Zend_Gdata_Books_Extension_BooksLink::getExtensionElements()| Type | Description |
|---|---|
| array | All elements not matched to data model classes during parsing |
getHref() : string | null| Type | Description |
|---|---|
| string | null |
getHrefLang() : string | null| Type | Description |
|---|---|
| string | null |
getLength() : string | null| Type | Description |
|---|---|
| string | null |
getRel() : string | null| Type | Description |
|---|---|
| string | null |
getText( $trim = true) : stringReturns 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_Extension::getText()\Zend_Gdata_App_Extension_Link::getText()\Zend_Gdata_Books_Extension_BooksLink::getText()| Name | Type | Description |
|---|---|---|
| $trim |
| Type | Description |
|---|---|
| string | Child text node |
getTitle() : string | null| Type | Description |
|---|---|
| string | null |
getType() : string | null| Type | Description |
|---|---|
| string | null |
getXML() : stringAlias for saveXML() returns XML content for this element and all +children
Inherited from: + \Zend_Gdata_App_Base::getXML()\Zend_Gdata_App_Extension::getXML()\Zend_Gdata_App_Extension_Link::getXML()\Zend_Gdata_Books_Extension_BooksLink::getXML()| Type | Description |
|---|---|
| string | XML content |
lookupNamespace(string $prefix, integer $majorVersion = 1, integer $minorVersion = null) : stringGet the full version of a namespace prefix
Inherited from: + \Zend_Gdata_App_Base::lookupNamespace()\Zend_Gdata_App_Extension::lookupNamespace()\Zend_Gdata_App_Extension_Link::lookupNamespace()\Zend_Gdata_Books_Extension_BooksLink::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.
| Name | Type | Description |
|---|---|---|
| $prefix | string | The namespace prefix to lookup. |
| $majorVersion | integer | The major protocol version in effect. + Defaults to '1'. + |
| $minorVersion | integer | The minor protocol version in effect. + Defaults to null (use latest). + |
| Type | Description |
|---|---|
| string |
registerAllNamespaces(array $namespaceArray) : voidAdd an array of namespaces to the registered list.
Inherited from: + \Zend_Gdata_App_Base::registerAllNamespaces()\Zend_Gdata_App_Extension::registerAllNamespaces()\Zend_Gdata_App_Extension_Link::registerAllNamespaces()\Zend_Gdata_Books_Extension_BooksLink::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()
| Name | Type | Description |
|---|---|---|
| $namespaceArray | array | An array of namespaces. |
registerNamespace(string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0) : voidAdd a namespace and prefix to the registered list
Inherited from: + \Zend_Gdata_App_Base::registerNamespace()\Zend_Gdata_App_Extension::registerNamespace()\Zend_Gdata_App_Extension_Link::registerNamespace()\Zend_Gdata_Books_Extension_BooksLink::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().
| 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). + |
saveXML() : stringConverts this element and all children into XML text using getDOM()
Inherited from: + \Zend_Gdata_App_Base::saveXML()\Zend_Gdata_App_Extension::saveXML()\Zend_Gdata_App_Extension_Link::saveXML()\Zend_Gdata_Books_Extension_BooksLink::saveXML()| Type | Description |
|---|---|
| string | XML content |
setExtensionAttributes(array $value) : \Zend_Gdata_App_BaseSets 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_Extension::setExtensionAttributes()\Zend_Gdata_App_Extension_Link::setExtensionAttributes()\Zend_Gdata_Books_Extension_BooksLink::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
| Name | Type | Description |
|---|---|---|
| $value | array | All extension attributes |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |
setExtensionElements(array $value) : \Zend_Gdata_App_BaseSets 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_Extension::setExtensionElements()\Zend_Gdata_App_Extension_Link::setExtensionElements()\Zend_Gdata_Books_Extension_BooksLink::setExtensionElements()This method can be used to add arbitrary +child XML elements to any data model class.
| Name | Type | Description |
|---|---|---|
| $value | array | All extension elements |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |
setHref(string | null $value) : \Zend_Gdata_App_Entry| Name | Type | Description |
|---|---|---|
| $value | string | null |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Entry | Provides a fluent interface |
setHrefLang(string | null $value) : \Zend_Gdata_App_Entry| Name | Type | Description |
|---|---|---|
| $value | string | null |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Entry | Provides a fluent interface |
setLength(string | null $value) : \Zend_Gdata_App_Entry| Name | Type | Description |
|---|---|---|
| $value | string | null |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Entry | Provides a fluent interface |
setRel(string | null $value) : \Zend_Gdata_App_Entry| Name | Type | Description |
|---|---|---|
| $value | string | null |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Entry | Provides a fluent interface |
setText(string $value) : \Zend_Gdata_App_BaseSets 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_Extension::setText()\Zend_Gdata_App_Extension_Link::setText()\Zend_Gdata_Books_Extension_BooksLink::setText()| Name | Type | Description |
|---|---|---|
| $value | string | Child text node |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Base | Returns an object of the same type as 'this' to provide a fluent interface. |
setTitle(string | null $value) : \Zend_Gdata_App_Entry| Name | Type | Description |
|---|---|---|
| $value | string | null |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Entry | Provides a fluent interface |
setType(string | null $value) : \Zend_Gdata_App_Entry| Name | Type | Description |
|---|---|---|
| $value | string | null |
| Type | Description |
|---|---|
| \Zend_Gdata_App_Entry | Provides a fluent interface |
takeAttributeFromDOM(\DOMNode $attribute) : voidGiven a DOMNode representing an attribute, tries to map the data into +instance members.
Inherited from: + \Zend_Gdata_App_Extension_Link::takeAttributeFromDOM()\Zend_Gdata_Books_Extension_BooksLink::takeAttributeFromDOM()If no mapping is defined, the name and value are +stored in an array.
| Name | Type | Description |
|---|---|---|
| $attribute | \DOMNode | The DOMNode attribute needed to be handled |
takeChildFromDOM(\DOMNode $child) : voidGiven a child DOMNode, tries to determine how to map the data into +object instance members.
Inherited from: + \Zend_Gdata_App_Base::takeChildFromDOM()\Zend_Gdata_App_Extension::takeChildFromDOM()\Zend_Gdata_App_Extension_Link::takeChildFromDOM()\Zend_Gdata_Books_Extension_BooksLink::takeChildFromDOM()If no mapping is defined, Extension_Element +objects are created and stored in an array.
| Name | Type | Description |
|---|---|---|
| $child | \DOMNode | The DOMNode needed to be handled |
transferFromDOM(\DOMNode $node) : voidTransfers each child and attribute into member variables.
Inherited from: + \Zend_Gdata_App_Base::transferFromDOM()\Zend_Gdata_App_Extension::transferFromDOM()\Zend_Gdata_App_Extension_Link::transferFromDOM()\Zend_Gdata_Books_Extension_BooksLink::transferFromDOM()This is called when XML is received over the wire and the data +model needs to be built to represent this XML.
| Name | Type | Description |
|---|---|---|
| $node | \DOMNode | The DOMNode that represents this object's data + |
transferFromXML(string $xml) : voidParses 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_Extension::transferFromXML()\Zend_Gdata_App_Extension_Link::transferFromXML()\Zend_Gdata_Books_Extension_BooksLink::transferFromXML()The first data model element with the same +name as $this->_rootElement is used and the child elements are +recursively parsed.
| Name | Type | Description |
|---|---|---|
| $xml | string | The XML text to parse |