Feed/Entry/Rss.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
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Feed
- Version
- $Id: Rss.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Feed_Entry_Rss
- Parent(s)
- \Zend_Feed_Entry_Abstract < \Zend_Feed_Element
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
boolean $_appended = truetrueDetails- Type
- boolean
- Inherited_from
- \Zend_Feed_Element::$$_appended
- Inherited_from
- \Zend_Feed_Entry_Abstract::$$_appended
\DOMElement $_element- Type
- \DOMElement
- Inherited_from
- \Zend_Feed_Element::$$_element
- Inherited_from
- \Zend_Feed_Entry_Abstract::$$_element
string $_encoding = 'UTF-8'Character encoding to utilize
'UTF-8'Details- Type
- string
- Inherited_from
- \Zend_Feed_Element::$$_encoding
- Inherited_from
- \Zend_Feed_Entry_Abstract::$$_encoding
\Zend_Feed_Element $_parentElement- Type
- \Zend_Feed_Element
- Inherited_from
- \Zend_Feed_Element::$$_parentElement
- Inherited_from
- \Zend_Feed_Entry_Abstract::$$_parentElement
string $_rootElement = 'item'Subclasses must define this to a non-null value.
'item'Details- Type
- string
string $_rootNamespace = nullSubclasses may define this to a non-null value.
nullDetails- Type
- string
- Inherited_from
- \Zend_Feed_Entry_Abstract::$$_rootNamespace
Methods
__call(string $var, mixed $unused) : mixedOverwrites parent::_call method to enable read access to content:encoded element.
Please note that method-style write access is not currently supported by parent method, consequently this method doesn't as well.
| Name | Type | Description |
|---|---|---|
| $var | string | The element to get the string value of. |
| $unused | mixed | This parameter is not used. |
| Type | Description |
|---|---|
| mixed | The node's value, null, or an array of nodes. |
__construct(string $uri = null, \SimpleXMLElement | \DOMNode | string $element = null) : voidZend_Feed_Entry_Abstract constructor
Inherited from: \Zend_Feed_Entry_Abstract::__construct()The Zend_Feed_Entry_Abstract constructor takes the URI of the feed the entry is part of, and optionally an XML construct (usually a SimpleXMLElement, but it can be an XML string or a DOMNode as well) that contains the contents of the entry.
| Name | Type | Description |
|---|---|---|
| $uri | string | |
| $element | \SimpleXMLElement | \DOMNode | string |
| Exception | Description |
|---|---|
| \Zend_Feed_Exception |
__get(string $var) : mixedOverwrites parent::_get method to enable read access to content:encoded element.
Get-style access returns a Zend_Feed_Element representing the child element accessed. To get string values, use method syntax with the __call() overriding.
| Name | Type | Description |
|---|---|---|
| $var | string | The property to access. |
| Type | Description |
|---|---|
| mixed |
__isset(string $var) : booleanOverwrites parent::_isset method to enable access to content:encoded element.
| Name | Type | Description |
|---|---|---|
| $var | string |
| Type | Description |
|---|---|
| boolean |
__set(string $var, $value) : voidOverwrites parent::_set method to enable write access to content:encoded element.
| Name | Type | Description |
|---|---|---|
| $var | string | The property to change. |
| $value |
| Exception | Description |
|---|---|
| \Zend_Feed_Exception |
__toString() : stringReturns the nodeValue of this element when this object is used in a string context.
Inherited from: \Zend_Feed_Element::__toString()\Zend_Feed_Entry_Abstract::__toString()| Type | Description |
|---|---|
| string |
__unset(string $var) : voidRemove all children matching $var.
Inherited from: \Zend_Feed_Element::__unset()\Zend_Feed_Entry_Abstract::__unset()| Name | Type | Description |
|---|---|---|
| $var | string |
_children(string $var) : arrayFinds children with tagnames matching $var
Inherited from: \Zend_Feed_Element::_children()\Zend_Feed_Entry_Abstract::_children()Similar to SimpleXML's children() method.
| Name | Type | Description |
|---|---|---|
| $var | string | Tagname to match, can be either namespace:tagName or just tagName. |
| Type | Description |
|---|---|
| array |
ensureAppended() : voidAppends this element to its parent if necessary.
Inherited from: \Zend_Feed_Element::ensureAppended()\Zend_Feed_Entry_Abstract::ensureAppended()getDOM() : \DOMDocumentGet a DOM representation of the element
Inherited from: \Zend_Feed_Element::getDOM()\Zend_Feed_Entry_Abstract::getDOM()Returns the underlying DOM object, which can then be manipulated with full DOM methods.
| Type | Description |
|---|---|
| \DOMDocument |
getEncoding() : stringGet encoding
Inherited from: \Zend_Feed_Element::getEncoding()\Zend_Feed_Entry_Abstract::getEncoding()| Type | Description |
|---|---|
| string |
offsetExists(string $offset) : booleanRequired by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetExists()\Zend_Feed_Entry_Abstract::offsetExists()| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| boolean |
offsetGet(string $offset) : stringRequired by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetGet()\Zend_Feed_Entry_Abstract::offsetGet()| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| string |
offsetSet(string $offset, string $value) : stringRequired by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetSet()\Zend_Feed_Entry_Abstract::offsetSet()| Name | Type | Description |
|---|---|---|
| $offset | string | |
| $value | string |
| Type | Description |
|---|---|
| string |
offsetUnset(string $offset) : booleanRequired by the ArrayAccess interface.
Inherited from: \Zend_Feed_Element::offsetUnset()\Zend_Feed_Entry_Abstract::offsetUnset()| Name | Type | Description |
|---|---|---|
| $offset | string |
| Type | Description |
|---|---|
| boolean |
saveXml() : stringGet an XML string representation of this element
Inherited from: \Zend_Feed_Element::saveXml()\Zend_Feed_Entry_Abstract::saveXml()Returns a string of this element's XML, including the XML prologue.
| Type | Description |
|---|---|
| string |
saveXmlFragment() : stringGet the XML for only this element
Inherited from: \Zend_Feed_Element::saveXmlFragment()\Zend_Feed_Entry_Abstract::saveXmlFragment()Returns a string of this element's XML without prologue.
| Type | Description |
|---|---|
| string |
setDOM(\DOMElement $element) : voidUpdate the object from a DOM element
Inherited from: \Zend_Feed_Element::setDOM()\Zend_Feed_Entry_Abstract::setDOM()Take a DOMElement object, which may be originally from a call to getDOM() or may be custom created, and use it as the DOM tree for this Zend_Feed_Element.
| Name | Type | Description |
|---|---|---|
| $element | \DOMElement |
setEncoding(string $value) : \Zend_Feed_ElementSet encoding
Inherited from: \Zend_Feed_Element::setEncoding()\Zend_Feed_Entry_Abstract::setEncoding()| Name | Type | Description |
|---|---|---|
| $value | string | Encoding to use |
| Type | Description |
|---|---|
| \Zend_Feed_Element |
setParent(\Zend_Feed_Element $element) : voidSet the parent element of this object to another Zend_Feed_Element.
Inherited from: \Zend_Feed_Element::setParent()\Zend_Feed_Entry_Abstract::setParent()| Name | Type | Description |
|---|---|---|
| $element | \Zend_Feed_Element |