API Documentation

Zend/Feed/Writer/Entry.php

Show: inherited
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_Writer  
Version
$Id: Entry.php 25159 2012-12-18 15:11:06Z matthew $  

\Zend_Feed_Writer_Entry

Package: Zend\Feed\Writer

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_data= 'array()'

Internal array containing all data associated with this entry or item.

Default valuearray()Details
Type
array
Propertyprotectedarray  $_extensions= 'array()'

Registered extensions

Default valuearray()Details
Type
array
Propertyprotectedstring  $_type= 'null'

Holds the value "atom" or "rss" depending on the feed type set when when last exported.

Default valuenullDetails
Type
string

Methods

methodpublic__call( string $method, array $args ) : mixed

Method overloading: call given method on first extension implementing it

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Feed_Exception if no extensions implements the method
methodpublic__construct( ) : void

Constructor: Primarily triggers the registration of core extensions and loads those appropriate to this data container.

methodprotected_loadExtensions( ) : void

Load extensions from Zend_Feed_Writer

methodpublicaddAuthor(  $name,  $email = null,  $uri = null ) : string|null

Set a single author

Parameters
Name Type Description
$name
$email
$uri
Returns
Type Description
string|null
methodpublicaddAuthors(  $authors ) : array

Set an array with feed authors

Parameters
Name Type Description
$authors
Returns
Type Description
array
methodpublicaddCategories( array $categories ) : void

Set an array of entry categories

Parameters
Name Type Description
$categories array
methodpublicaddCategory( string $category ) : void

Add a entry category

Parameters
Name Type Description
$category string
methodpubliccreateSource( ) : \Zend_Feed_Writer_Source

Creates a new Zend_Feed_Writer_Source data container for use. This is NOT added to the current feed automatically, but is necessary to create a container with some initial values preset based on the current feed data.

Returns
Type Description
\Zend_Feed_Writer_Source
methodpublicgetAuthors( ) : array

Get an array with feed authors

Returns
Type Description
array
methodpublicgetCategories( ) : string|null

Get the entry categories

Returns
Type Description
string|null
methodpublicgetCommentCount( ) : integer

Get the number of comments/replies for current entry

Returns
Type Description
integer
methodpublicgetCommentFeedLinks( ) : string

Returns an array of URIs pointing to a feed of all comments for this entry where the array keys indicate the feed type (atom, rss or rdf).

Returns
Type Description
string
methodpublicgetCommentLink( ) : string

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

Returns
Type Description
string
methodpublicgetContent( ) : string

Get the entry content

Returns
Type Description
string
methodpublicgetCopyright( ) : string

Get the entry copyright information

Returns
Type Description
string
methodpublicgetDateCreated( ) : string

Get the entry creation date

Returns
Type Description
string
methodpublicgetDateModified( ) : string

Get the entry modification date

Returns
Type Description
string
methodpublicgetDescription( ) : string

Get the entry description

Returns
Type Description
string
methodpublicgetEnclosure( ) : array

Retrieve an array of all enclosures to be added to entry.

Returns
Type Description
array
methodpublicgetEncoding( ) : string|null

Get the feed character encoding

Returns
Type Description
string|null
methodpublicgetExtension( string $name ) : object

Return an Extension object with the matching name (postfixed with _Entry)

Parameters
Name Type Description
$name string
Returns
Type Description
object
methodpublicgetExtensions( ) : array

Get registered extensions

Returns
Type Description
array
methodpublicgetId( ) : string

Get the entry ID

Returns
Type Description
string
methodpublicgetLink( ) : string|null

Get a link to the HTML source

Returns
Type Description
string|null
methodpublicgetLinks( ) : array

Get all links

Returns
Type Description
array
methodpublicgetSource( ) : \Zend_Feed_Writer_Source

Returns
Type Description
\Zend_Feed_Writer_Source
methodpublicgetTitle( ) : string

Get the entry title

Returns
Type Description
string
methodpublicgetType( ) : string

Retrieve the current or last feed type exported.

Returns
Type Description
string Value will be "rss" or "atom"
methodpublicremove( string $name ) : void

Unset a specific data point

Parameters
Name Type Description
$name string
methodpublicsetCommentCount(  $count ) : string|null

Set the number of comments associated with this entry

Parameters
Name Type Description
$count
Returns
Type Description
string|null
methodpublicsetCommentFeedLink(  $link ) : string|null

Set a link to an XML feed for any comments associated with this entry

Parameters
Name Type Description
$link
Returns
Type Description
string|null
methodpublicsetCommentFeedLinks(  $links ) : string|null

Set a links to an XML feed for any comments associated with this entry.

Each link is an array with keys "uri" and "type", where type is one of: "atom", "rss" or "rdf".

Parameters
Name Type Description
$links
Returns
Type Description
string|null
methodpublicsetCommentLink(  $link ) : string|null

Set a link to a HTML page containing comments associated with this entry

Parameters
Name Type Description
$link
Returns
Type Description
string|null
methodpublicsetContent(  $content ) : string|null

Set the entry's content

Parameters
Name Type Description
$content
Returns
Type Description
string|null
methodpublicsetCopyright(  $copyright ) : string|null

Set the copyright entry

Parameters
Name Type Description
$copyright
Returns
Type Description
string|null
methodpublicsetDateCreated(  $date = null ) : string|null

Set the feed creation date

Parameters
Name Type Description
$date
Returns
Type Description
string|null
methodpublicsetDateModified(  $date = null ) : string|null

Set the feed modification date

Parameters
Name Type Description
$date
Returns
Type Description
string|null
methodpublicsetDescription(  $description ) : string|null

Set the feed description

Parameters
Name Type Description
$description
Returns
Type Description
string|null
methodpublicsetEnclosure(  $enclosure ) : void

Adds an enclosure to the entry. The array parameter may contain the keys 'uri', 'type' and 'length'. Only 'uri' is required for Atom, though the others must also be provided or RSS rendering (where they are required) will throw an Exception.

Parameters
Name Type Description
$enclosure
methodpublicsetEncoding(  $encoding ) : string|null

Set the feed character encoding

Parameters
Name Type Description
$encoding
Returns
Type Description
string|null
methodpublicsetId(  $id ) : string|null

Set the feed ID

Parameters
Name Type Description
$id
Returns
Type Description
string|null
methodpublicsetLink(  $link ) : string|null

Set a link to the HTML source of this entry

Parameters
Name Type Description
$link
Returns
Type Description
string|null
methodpublicsetSource( \Zend_Feed_Writer_Source $source ) : void

Appends a Zend_Feed_Writer_Entry object representing a new entry/item the feed data container's internal group of entries.

Parameters
Name Type Description
$source \Zend_Feed_Writer_Source
methodpublicsetTitle(  $title ) : string|null

Set the feed title

Parameters
Name Type Description
$title
Returns
Type Description
string|null
methodpublicsetType( string $type ) : void

Set the current feed type being exported to "rss" or "atom". This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.

Parameters
Name Type Description
$type string
Documentation was generated by DocBlox 0.15.1.