Feed/Entry/Abstract.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_Feed  
Version
$Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Feed_Entry_Abstract

Package: Zend\Feed
Zend_Feed_Entry_Abstract represents a single entry in an Atom or RSS feed.
Parent(s)
\Zend_Feed_Element
Children
\Zend_Feed_Entry_Rss
\Zend_Feed_Entry_Atom
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedboolean $_appended = true
inherited
Inherited from: \Zend_Feed_Element::$$_appended
Default valuetrueDetails
Type
boolean
Inherited_from
\Zend_Feed_Element::$$_appended  
>VPropertyprotected\DOMElement $_element
inherited
Inherited from: \Zend_Feed_Element::$$_element
Details
Type
\DOMElement
Inherited_from
\Zend_Feed_Element::$$_element  
>VPropertyprotectedstring $_encoding = 'UTF-8'
inherited

Character encoding to utilize

Inherited from: \Zend_Feed_Element::$$_encoding
Default value'UTF-8'Details
Type
string
Inherited_from
\Zend_Feed_Element::$$_encoding  
>VPropertyprotected\Zend_Feed_Element $_parentElement
inherited
Inherited from: \Zend_Feed_Element::$$_parentElement
>VPropertyprotectedstring $_rootElement
Root XML element for entries.

Subclasses must define this to a non-null value.

Details
Type
string
>VPropertyprotectedstring $_rootNamespace = null
Root namespace for entries.

Subclasses may define this to a non-null value.

Default valuenullDetails
Type
string

Methods

methodpublic__call(string $var, mixed $unused) : mixed
inherited

Get the value of an element with method syntax.

Inherited from: \Zend_Feed_Element::__call()

Map method calls to get the string value of the requested element. If there are multiple elements that match, this will return an array of those objects.

Parameters
NameTypeDescription
$varstring

The element to get the string value of.

$unusedmixed

This parameter is not used.

Returns
TypeDescription
mixedThe node's value, null, or an array of nodes.
methodpublic__construct(string $uri = null, \SimpleXMLElement | \DOMNode | string $element = null) : void

Zend_Feed_Entry_Abstract constructor

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.

Parameters
NameTypeDescription
$uristring
$element\SimpleXMLElement | \DOMNode | string
Throws
ExceptionDescription
\Zend_Feed_Exception
methodpublic__get(string $var) : mixed
inherited

Map variable access onto the underlying entry representation.

Inherited from: \Zend_Feed_Element::__get()

Get-style access returns a Zend_Feed_Element representing the child element accessed. To get string values, use method syntax with the __call() overriding.

Parameters
NameTypeDescription
$varstring

The property to access.

Returns
TypeDescription
mixed
methodpublic__isset(string $var) : boolean
inherited

Map isset calls onto the underlying entry representation.

Inherited from: \Zend_Feed_Element::__isset()
Parameters
NameTypeDescription
$varstring
Returns
TypeDescription
boolean
methodpublic__set(string $var, string $val) : void
inherited

Map variable sets onto the underlying entry representation.

Inherited from: \Zend_Feed_Element::__set()
Parameters
NameTypeDescription
$varstring

The property to change.

$valstring

The property's new value.

Throws
ExceptionDescription
\Zend_Feed_Exception
methodpublic__toString() : string
inherited

Returns the nodeValue of this element when this object is used in a string context.

Inherited from: \Zend_Feed_Element::__toString()
Returns
TypeDescription
string
methodpublic__unset(string $var) : void
inherited

Remove all children matching $var.

Inherited from: \Zend_Feed_Element::__unset()
Parameters
NameTypeDescription
$varstring
methodprotected_children(string $var) : array
inherited

Finds children with tagnames matching $var

Inherited from: \Zend_Feed_Element::_children()

Similar to SimpleXML's children() method.

Parameters
NameTypeDescription
$varstring

Tagname to match, can be either namespace:tagName or just tagName.

Returns
TypeDescription
array
methodprotectedensureAppended() : void
inherited

Appends this element to its parent if necessary.

Inherited from: \Zend_Feed_Element::ensureAppended()
methodpublicgetDOM() : \DOMDocument
inherited

Get a DOM representation of the element

Inherited from: \Zend_Feed_Element::getDOM()

Returns the underlying DOM object, which can then be manipulated with full DOM methods.

Returns
TypeDescription
\DOMDocument
methodpublicgetEncoding() : string
inherited

Get encoding

Inherited from: \Zend_Feed_Element::getEncoding()
Returns
TypeDescription
string
methodpublicoffsetExists(string $offset) : boolean
inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetExists()
Parameters
NameTypeDescription
$offsetstring
Returns
TypeDescription
boolean
methodpublicoffsetGet(string $offset) : string
inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetGet()
Parameters
NameTypeDescription
$offsetstring
Returns
TypeDescription
string
methodpublicoffsetSet(string $offset, string $value) : string
inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetSet()
Parameters
NameTypeDescription
$offsetstring
$valuestring
Returns
TypeDescription
string
methodpublicoffsetUnset(string $offset) : boolean
inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetUnset()
Parameters
NameTypeDescription
$offsetstring
Returns
TypeDescription
boolean
methodpublicsaveXml() : string
inherited

Get an XML string representation of this element

Inherited from: \Zend_Feed_Element::saveXml()

Returns a string of this element's XML, including the XML prologue.

Returns
TypeDescription
string
methodpublicsaveXmlFragment() : string
inherited

Get the XML for only this element

Inherited from: \Zend_Feed_Element::saveXmlFragment()

Returns a string of this element's XML without prologue.

Returns
TypeDescription
string
methodpublicsetDOM(\DOMElement $element) : void
inherited

Update the object from a DOM element

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

Parameters
NameTypeDescription
$element\DOMElement
methodpublicsetEncoding(string $value) : \Zend_Feed_Element
inherited

Set encoding

Inherited from: \Zend_Feed_Element::setEncoding()
Parameters
NameTypeDescription
$valuestring

Encoding to use

Returns
TypeDescription
\Zend_Feed_Element
methodpublicsetParent(\Zend_Feed_Element $element) : void
inherited

Set the parent element of this object to another Zend_Feed_Element.

Inherited from: \Zend_Feed_Element::setParent()
Parameters
NameTypeDescription
$element\Zend_Feed_Element
Documentation was generated by phpDocumentor 2.0.0a12.