Feed/Reader/Extension/Atom/Entry.php

Show:

inherited

Classes
- \Zend_Feed_Reader_Extension_Atom_Entry

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 [email protected] 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
jump to top

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

array $_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

\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

\Zend_Feed_Entry_Abstract $_entry = null

inherited

Entry instance

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_entry

Default valuenullDetails

Type: \Zend_Feed_Entry_Abstract
Inherited_from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_entry

int $_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

\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

string $_xpathPrefix = ''

inherited

XPath query

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_xpathPrefix

Default value''Details

Type: string
Inherited_from: \Zend_Feed_Reader_Extension_EntryAbstract::$$_xpathPrefix

Methods

__construct(\Zend_Feed_Entry_Abstract $entry, int $entryKey, string $type = null) : void

inherited

Constructor

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::__construct()

Parameters

Name	Type	Description
$entry	\Zend_Feed_Entry_Abstract
$entryKey	int
$type	string

_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

Name	Type	Description
$link

_collectXhtml( $xhtml, $prefix) : void

Parse out XHTML to remove the namespacing

Parameters

Name	Type	Description
$xhtml
$prefix

_getAtomType() : void

Detect the presence of any Atom namespaces in use

_getAuthor(\DOMElement $element) : string

Get an author entry

Parameters

Name	Type	Description
$element	\DOMElement

Returns

Type	Description
string

_registerNamespaces() : void

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

Get the specified author

Parameters

Name	Type	Description
$index	int

Returns

Type	Description
string \| null

getAuthors() : array

Get an array with feed authors

Returns

Type	Description
array

getBaseUrl() : string | null

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

Returns

Type	Description
string \| null

getCategories() : \Zend_Feed_Reader_Collection_Category

Get all categories

Returns

Type	Description
\Zend_Feed_Reader_Collection_Category

getCommentCount() : integer

Get the number of comments/replies for current entry

Returns

Type	Description
integer

getCommentFeedLink( $type = 'atom') : string

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

Parameters

Name	Type	Description
$type

Returns

Type	Description
string

getCommentLink() : string

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

Returns

Type	Description
string

getContent() : string

Get the entry content

Returns

Type	Description
string

getDateCreated() : string

Get the entry creation date

Returns

Type	Description
string

getDateModified() : string

Get the entry modification date

Returns

Type	Description
string

getDescription() : string

Get the entry description

Returns

Type	Description
string

getDomDocument() : \DOMDocument

inherited

Get the DOM

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getDomDocument()

Returns

Type	Description
\DOMDocument

getEnclosure() : string

Get the entry enclosure

Returns

Type	Description
string

getEncoding() : string

inherited

Get the Entry's encoding

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getEncoding()

Returns

Type	Description
string

getId() : string

Get the entry ID

Returns

Type	Description
string

getLink(int $index = 0) : string

Get a specific link

Parameters

Name	Type	Description
$index	int

Returns

Type	Description
string

getLinks() : array

Get all links

Returns

Type	Description
array

getPermalink() : string

Get a permalink to the entry

Returns

Type	Description
string

getSource() : \Zend_Feed_Reader_Feed_Atom_Source | null

Get source feed metadata from the entry

Returns

Type	Description
\Zend_Feed_Reader_Feed_Atom_Source \| null

getTitle() : string

Get the entry title

Returns

Type	Description
string

getType() : string

inherited

Get the entry type

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getType()

Returns

Type	Description
string

getXpath() : \DOMXPath

inherited

Get the XPath query object

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getXpath()

Returns

Type	Description
\DOMXPath

getXpathPrefix() : string

inherited

Get the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::getXpathPrefix()

Returns

Type	Description
string

setXpath(\DOMXPath $xpath) : \Zend_Feed_Reader_Extension_EntryAbstract

inherited

Set the XPath query

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::setXpath()

Parameters

Name	Type	Description
$xpath	\DOMXPath

Returns

Type	Description
\Zend_Feed_Reader_Extension_EntryAbstract

setXpathPrefix(string $prefix) : \Zend_Feed_Reader_Extension_EntryAbstract

inherited

Set the XPath prefix

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::setXpathPrefix()

Parameters

Name	Type	Description
$prefix	string

Returns

Type	Description
\Zend_Feed_Reader_Extension_EntryAbstract

toArray() : array

inherited

Serialize the entry to an array

Inherited from: \Zend_Feed_Reader_Extension_EntryAbstract::toArray()

Returns

Type	Description
array

Feed/Reader/Extension/Atom/Entry.php

\Zend_Feed_Reader_Extension_Atom_Entryjump to top

Properties

Methods

\Zend_Feed_Reader_Extension_Atom_Entry
jump to top