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

\Zend_Feed_Reader_Extension_Atom_Entry

Package: Zend\Feed\Reader
Parent(s)
\Zend_Feed_Reader_Extension_EntryAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_data = array()
inherited
Feed entry data
Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_data
Default valuearray()Details
Type
array
Inherited_from
\Zend_Feed_Reader_Extension_EntryAbstract::$$_data  
>VPropertyprotected\DOMDocument $_domDocument = null
inherited
DOM document object
Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_domDocument
Default valuenullDetails
Type
\DOMDocument
Inherited_from
\Zend_Feed_Reader_Extension_EntryAbstract::$$_domDocument  
>VPropertyprotected\Zend_Feed_Entry_Abstract $_entry = null
inherited
Entry instance
Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_entry
>VPropertyprotectedint $_entryKey = 0
inherited
Pointer to the current entry
Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_entryKey
Default value0Details
Type
int
Inherited_from
\Zend_Feed_Reader_Extension_EntryAbstract::$$_entryKey  
>VPropertyprotected\DOMXPath $_xpath = null
inherited
XPath object
Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_xpath
Default valuenullDetails
Type
\DOMXPath
Inherited_from
\Zend_Feed_Reader_Extension_EntryAbstract::$$_xpath  
>VPropertyprotectedstring $_xpathPrefix = ''
Default value''Details
Type
string
Inherited_from
\Zend_Feed_Reader_Extension_EntryAbstract::$$_xpathPrefix  

Methods

methodpublic__construct(\Zend_Feed_Entry_Abstract $entry, int $entryKey, string $type = null) : void
Parameters
NameTypeDescription
$entry\Zend_Feed_Entry_Abstract
$entryKeyint
$typestring
methodprotected_absolutiseUri( $link) : void

Attempt to absolutise the URI, i.e.

if a relative URI apply the xml:base value as a prefix to turn into an absolute URI.

Parameters
NameTypeDescription
$link
methodprotected_collectXhtml( $xhtml,  $prefix) : void

Parse out XHTML to remove the namespacing

Parameters
NameTypeDescription
$xhtml
$prefix
methodprotected_getAtomType() : void

Detect the presence of any Atom namespaces in use

methodprotected_getAuthor(\DOMElement $element) : string

Get an author entry

Parameters
NameTypeDescription
$element\DOMElement
Returns
TypeDescription
string
methodprotected_registerNamespaces() : void

Register the default namespaces for the current feed format

methodpublicgetAuthor(int $index = 0) : string | null

Get the specified author

Parameters
NameTypeDescription
$indexint
Returns
TypeDescription
string | null
methodpublicgetAuthors() : array

Get an array with feed authors

Returns
TypeDescription
array
methodpublicgetBaseUrl() : string | null

Get the base URI of the feed (if set).

Returns
TypeDescription
string | null
methodpublicgetCategories() : \Zend_Feed_Reader_Collection_Category

Get all categories

methodpublicgetCommentCount() : integer

Get the number of comments/replies for current entry

Returns
TypeDescription
integer
methodpublicgetCommentFeedLink( $type = 'atom') : string

Returns a URI pointing to a feed of all comments for this entry

Parameters
NameTypeDescription
$type
Returns
TypeDescription
string
methodpublicgetCommentLink() : string

Returns a URI pointing to the HTML page where comments can be made on this entry

Returns
TypeDescription
string
methodpublicgetContent() : string

Get the entry content

Returns
TypeDescription
string
methodpublicgetDateCreated() : string

Get the entry creation date

Returns
TypeDescription
string
methodpublicgetDateModified() : string

Get the entry modification date

Returns
TypeDescription
string
methodpublicgetDescription() : string

Get the entry description

Returns
TypeDescription
string
methodpublicgetDomDocument() : \DOMDocument
Returns
TypeDescription
\DOMDocument
methodpublicgetEnclosure() : string

Get the entry enclosure

Returns
TypeDescription
string
methodpublicgetEncoding() : string
inherited

Get the Entry's encoding

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getEncoding()
Returns
TypeDescription
string
methodpublicgetId() : string

Get the entry ID

Returns
TypeDescription
string
methodpublicgetLink(int $index = 0) : string

Get a specific link

Parameters
NameTypeDescription
$indexint
Returns
TypeDescription
string
methodpublicgetLinks() : array

Get all links

Returns
TypeDescription
array
methodpublicgetPermalink() : string

Get a permalink to the entry

Returns
TypeDescription
string
methodpublicgetSource() : \Zend_Feed_Reader_Feed_Atom_Source | null

Get source feed metadata from the entry

Returns
TypeDescription
\Zend_Feed_Reader_Feed_Atom_Source | null
methodpublicgetTitle() : string

Get the entry title

Returns
TypeDescription
string
methodpublicgetType() : string
inherited

Get the entry type

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getType()
Returns
TypeDescription
string
methodpublicgetXpath() : \DOMXPath
inherited

Get the XPath query object

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getXpath()
Returns
TypeDescription
\DOMXPath
methodpublicgetXpathPrefix() : string
inherited

Get the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getXpathPrefix()
Returns
TypeDescription
string
methodpublicsetXpath(\DOMXPath $xpath) : \Zend_Feed_Reader_Extension_EntryAbstract
inherited

Set the XPath query

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::setXpath()
Parameters
NameTypeDescription
$xpath\DOMXPath
Returns
TypeDescription
\Zend_Feed_Reader_Extension_EntryAbstract
methodpublicsetXpathPrefix(string $prefix) : \Zend_Feed_Reader_Extension_EntryAbstract
inherited

Set the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::setXpathPrefix()
Parameters
NameTypeDescription
$prefixstring
Returns
TypeDescription
\Zend_Feed_Reader_Extension_EntryAbstract
methodpublictoArray() : array
inherited

Serialize the entry to an array

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::toArray()
Returns
TypeDescription
array
Documentation was generated by phpDocumentor 2.0.0a12.