Feed/Entry/Atom.php

Show:

inherited

Classes
- \Zend_Feed_Entry_Atom

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: Atom.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Feed_Entry_Atom
jump to top

Package: Zend\Feed

Concrete class for working with Atom entries.

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

Constants

 
                CONTENT_TYPE
                = 'application/atom+xml'

Content-Type

Properties

boolean $_appended = true

inherited

Inherited from: \Zend_Feed_Element::$$_appended \Zend_Feed_Entry_Abstract::$$_appended

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Feed_Element::$$_appended
Inherited_from: \Zend_Feed_Entry_Abstract::$$_appended

\DOMElement $_element

inherited

Inherited from: \Zend_Feed_Element::$$_element \Zend_Feed_Entry_Abstract::$$_element

Details

Type: \DOMElement
Inherited_from: \Zend_Feed_Element::$$_element
Inherited_from: \Zend_Feed_Entry_Abstract::$$_element

string $_encoding = 'UTF-8'

inherited

Character encoding to utilize

Inherited from: \Zend_Feed_Element::$$_encoding \Zend_Feed_Entry_Abstract::$$_encoding

Default value'UTF-8'Details

Type: string
Inherited_from: \Zend_Feed_Element::$$_encoding
Inherited_from: \Zend_Feed_Entry_Abstract::$$_encoding

\Zend_Feed_Element $_parentElement

inherited

Inherited from: \Zend_Feed_Element::$$_parentElement \Zend_Feed_Entry_Abstract::$$_parentElement

Details

Type: \Zend_Feed_Element
Inherited_from: \Zend_Feed_Element::$$_parentElement
Inherited_from: \Zend_Feed_Entry_Abstract::$$_parentElement

string $_rootElement = 'entry'

Root XML element for Atom entries.

Subclasses must define this to a non-null value.

Default value'entry'Details

Type: string

string $_rootNamespace = 'atom'

Root namespace for Atom entries.

Subclasses may define this to a non-null value.

Default value'atom'Details

Type: string

Methods

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

inherited

Get the value of an element with method syntax.

Inherited from: \Zend_Feed_Element::__call()\Zend_Feed_Entry_Abstract::__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

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(string $uri = null, \SimpleXMLElement | \DOMNode | string $element = null) : void

inherited

Zend_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.

Parameters

Name	Type	Description
$uri	string
$element	\SimpleXMLElement \| \DOMNode \| string

Throws

Exception	Description
\Zend_Feed_Exception

__get(string $var) : mixed

inherited

Map variable access onto the underlying entry representation.

Inherited from: \Zend_Feed_Element::__get()\Zend_Feed_Entry_Abstract::__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

Name	Type	Description
$var	string	The property to access.

Returns

Type	Description
mixed

__isset(string $var) : boolean

inherited

Map isset calls onto the underlying entry representation.

Inherited from: \Zend_Feed_Element::__isset()\Zend_Feed_Entry_Abstract::__isset()

Parameters

Name	Type	Description
$var	string

Returns

Type	Description
boolean

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

inherited

Map variable sets onto the underlying entry representation.

Inherited from: \Zend_Feed_Element::__set()\Zend_Feed_Entry_Abstract::__set()

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

inherited

Returns 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()

Returns

Type	Description
string

__unset(string $var) : void

inherited

Remove all children matching $var.

Inherited from: \Zend_Feed_Element::__unset()\Zend_Feed_Entry_Abstract::__unset()

Parameters

Name	Type	Description
$var	string

_children(string $var) : array

inherited

Finds children with tagnames matching $var

Inherited from: \Zend_Feed_Element::_children()\Zend_Feed_Entry_Abstract::_children()

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

delete() : void

Delete an atom entry.

Delete tries to delete this entry from its feed. If the entry does not contain a link rel="edit", we throw an error (either the entry does not yet exist or this is not an editable feed). If we have a link rel="edit", we do the empty-body HTTP DELETE to that URI and check for a response of 2xx. Usually the response would be 204 No Content, but the Atom Publishing Protocol permits it to be 200 OK.

Throws

Exception	Description
\Zend_Feed_Exception

ensureAppended() : void

inherited

Appends this element to its parent if necessary.

Inherited from: \Zend_Feed_Element::ensureAppended()\Zend_Feed_Entry_Abstract::ensureAppended()

getDOM() : \DOMDocument

inherited

Get 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.

Returns

Type	Description
\DOMDocument

getEncoding() : string

inherited

Get encoding

Inherited from: \Zend_Feed_Element::getEncoding()\Zend_Feed_Entry_Abstract::getEncoding()

Returns

Type	Description
string

link(string $rel = null) : mixed

Easy access to tags keyed by "rel" attributes.

If $elt->link() is called with no arguments, we will attempt to return the value of the tag(s) like all other method-syntax attribute access. If an argument is passed to link(), however, then we will return the "href" value of the first tag that has a "rel" attribute matching $rel:

$elt->link(): returns the value of the link tag. $elt->link('self'): returns the href from the first in the entry.

Parameters

Name	Type	Description
$rel	string	The "rel" attribute to look for.

Returns

Type	Description
mixed

offsetExists(string $offset) : boolean

inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetExists()\Zend_Feed_Entry_Abstract::offsetExists()

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
boolean

offsetGet(string $offset) : string

inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetGet()\Zend_Feed_Entry_Abstract::offsetGet()

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
string

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

inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetSet()\Zend_Feed_Entry_Abstract::offsetSet()

Parameters

Name	Type	Description
$offset	string
$value	string

Returns

Type	Description
string

offsetUnset(string $offset) : boolean

inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetUnset()\Zend_Feed_Entry_Abstract::offsetUnset()

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
boolean

save(string $postUri = null) : void

Save a new or updated Atom entry.

Save is used to either create new entries or to save changes to existing ones. If we have a link rel="edit", we are changing an existing entry. In this case we re-serialize the entry and PUT it to the edit URI, checking for a 200 OK result.

For posting new entries, you must specify the $postUri parameter to save() to tell the object where to post itself. We use $postUri and POST the serialized entry there, checking for a 201 Created response. If the insert is successful, we then parse the response from the POST to get any values that the server has generated: an id, an updated time, and its new link rel="edit".

Parameters

Name	Type	Description
$postUri	string	Location to POST for creating new entries.

Throws

Exception	Description
\Zend_Feed_Exception

saveXml() : string

inherited

Get 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.

Returns

Type	Description
string

saveXmlFragment() : string

inherited

Get 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.

Returns

Type	Description
string

setDOM(\DOMElement $element) : void

inherited

Update 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.

Parameters

Name	Type	Description
$element	\DOMElement

setEncoding(string $value) : \Zend_Feed_Element

inherited

Set encoding

Inherited from: \Zend_Feed_Element::setEncoding()\Zend_Feed_Entry_Abstract::setEncoding()

Parameters

Name	Type	Description
$value	string	Encoding to use

Returns

Type	Description
\Zend_Feed_Element

setParent(\Zend_Feed_Element $element) : void

inherited

Set the parent element of this object to another Zend_Feed_Element.

Inherited from: \Zend_Feed_Element::setParent()\Zend_Feed_Entry_Abstract::setParent()

Parameters

Name	Type	Description
$element	\Zend_Feed_Element

Feed/Entry/Atom.php

\Zend_Feed_Entry_Atomjump to top

Constants

Properties

Methods

\Zend_Feed_Entry_Atom
jump to top