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

\Zend_Feed_Entry_Atom

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

>VConstant  CONTENT_TYPE = 'application/atom+xml'
Content-Type

Properties

>VPropertyprotectedboolean $_appended = true
Default valuetrueDetails
Type
boolean
Inherited_from
\Zend_Feed_Element::$$_appended  
Inherited_from
\Zend_Feed_Entry_Abstract::$$_appended  
>VPropertyprotectedstring $_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  
>VPropertyprotectedstring $_rootElement = 'entry'
Root XML element for Atom entries.

Subclasses must define this to a non-null value.

Default value'entry'Details
Type
string
>VPropertyprotectedstring $_rootNamespace = 'atom'
Root namespace for Atom entries.

Subclasses may define this to a non-null value.

Default value'atom'Details
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()\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
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
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
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()\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
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()\Zend_Feed_Entry_Abstract::__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()\Zend_Feed_Entry_Abstract::__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()\Zend_Feed_Entry_Abstract::__toString()
Returns
TypeDescription
string
methodpublic__unset(string $var) : void
inherited

Remove all children matching $var.

Inherited from: \Zend_Feed_Element::__unset()\Zend_Feed_Entry_Abstract::__unset()
Parameters
NameTypeDescription
$varstring
methodprotected_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
NameTypeDescription
$varstring

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

Returns
TypeDescription
array
methodpublicdelete() : 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
ExceptionDescription
\Zend_Feed_Exception
methodprotectedensureAppended() : void
inherited

Appends this element to its parent if necessary.

Inherited from: \Zend_Feed_Element::ensureAppended()\Zend_Feed_Entry_Abstract::ensureAppended()
methodpublicgetDOM() : \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
TypeDescription
\DOMDocument
methodpublicgetEncoding() : string
Returns
TypeDescription
string
methodpubliclink(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
NameTypeDescription
$relstring

The "rel" attribute to look for.

Returns
TypeDescription
mixed
methodpublicoffsetExists(string $offset) : boolean
inherited

Required by the ArrayAccess interface.

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

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetGet()\Zend_Feed_Entry_Abstract::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()\Zend_Feed_Entry_Abstract::offsetSet()
Parameters
NameTypeDescription
$offsetstring
$valuestring
Returns
TypeDescription
string
methodpublicoffsetUnset(string $offset) : boolean
inherited

Required by the ArrayAccess interface.

Inherited from: \Zend_Feed_Element::offsetUnset()\Zend_Feed_Entry_Abstract::offsetUnset()
Parameters
NameTypeDescription
$offsetstring
Returns
TypeDescription
boolean
methodpublicsave(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
NameTypeDescription
$postUristring

Location to POST for creating new entries.

Throws
ExceptionDescription
\Zend_Feed_Exception
methodpublicsaveXml() : 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
TypeDescription
string
methodpublicsaveXmlFragment() : 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
TypeDescription
string
methodpublicsetDOM(\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
NameTypeDescription
$element\DOMElement
methodpublicsetEncoding(string $value) : \Zend_Feed_Element
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()\Zend_Feed_Entry_Abstract::setParent()
Parameters
NameTypeDescription
$element\Zend_Feed_Element
Documentation was generated by phpDocumentor 2.0.0a12.