Feed/Element.php

Show:

inherited

Classes
- \Zend_Feed_Element

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Feed
Version: $Id$

\Zend_Feed_Element
jump to top

Package: Zend_Feed

Wraps a DOMElement allowing for SimpleXML-like access to attributes.

Implements
Children: \Zend_Feed_Entry_Abstract; \Zend_Feed_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

boolean $_appended = true

Default valuetrueDetails

Type: boolean

\DOMElement $_element

Details

Type: \DOMElement

string $_encoding = 'UTF-8'

Character encoding to utilize

Default value'UTF-8'Details

Type: string

\Zend_Feed_Element $_parentElement

Details

Type: \Zend_Feed_Element

Methods

__call(string $var, mixed $unused) : mixed

Get the value of an element with method syntax.

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

Name	Type	Description
$var	string	The element to get the string value of.
$unused	mixed	This parameter is not used.

Returns

Type	Description
mixed	The node's value, null, or an array of nodes.

__construct(\DOMElement $element = null) : void

Zend_Feed_Element constructor.

Parameters

Name	Type	Description
$element	\DOMElement	The DOM element we're encapsulating.

__get(string $var) : mixed

Map variable access onto the underlying entry representation.

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

Name	Type	Description
$var	string	The property to access.

Returns

Type	Description
mixed

__isset(string $var) : boolean

Map isset calls onto the underlying entry representation.

Parameters

Name	Type	Description
$var	string

Returns

Type	Description
boolean

__set(string $var, string $val) : void

Map variable sets onto the underlying entry representation.

Parameters

Name	Type	Description
$var	string	The property to change.
$val	string	The property's new value.

Throws

Exception	Description
\Zend_Feed_Exception

__toString() : string

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

Returns

Type	Description
string

__unset(string $var) : void

Remove all children matching $var.

Parameters

Name	Type	Description
$var	string

_children(string $var) : array

Finds children with tagnames matching $var

Similar to SimpleXML's children() method.

Parameters

Name	Type	Description
$var	string	Tagname to match, can be either namespace:tagName or just tagName.

Returns

Type	Description
array

ensureAppended() : void

Appends this element to its parent if necessary.

getDOM() : \DOMDocument

Get a DOM representation of the element

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

Returns

Type	Description
\DOMDocument

getEncoding() : string

Get encoding

Returns

Type	Description
string

offsetExists(string $offset) : boolean

Required by the ArrayAccess interface.

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
boolean

offsetGet(string $offset) : string

Required by the ArrayAccess interface.

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
string

offsetSet(string $offset, string $value) : string

Required by the ArrayAccess interface.

Parameters

Name	Type	Description
$offset	string
$value	string

Returns

Type	Description
string

offsetUnset(string $offset) : boolean

Required by the ArrayAccess interface.

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
boolean

saveXml() : string

Get an XML string representation of this element

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

Returns

Type	Description
string

saveXmlFragment() : string

Get the XML for only this element

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

Returns

Type	Description
string

setDOM(\DOMElement $element) : void

Update the object from a DOM element

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

Name	Type	Description
$element	\DOMElement

setEncoding(string $value) : \Zend_Feed_Element

Set encoding

Parameters

Name	Type	Description
$value	string	Encoding to use

Returns

Type	Description
\Zend_Feed_Element

setParent(\Zend_Feed_Element $element) : void

Set the parent element of this object to another Zend_Feed_Element.

Parameters

Name	Type	Description
$element	\Zend_Feed_Element

Feed/Element.php

\Zend_Feed_Elementjump to top

Properties

Methods

\Zend_Feed_Element
jump to top