API Documentation

Feed/Writer/Entry.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Writer
version
$Id: Entry.php 22065 2010-04-30 14:04:57Z padraic $
Classes
Zend_Feed_Writer_Entry

Description

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.

Zend_Feed_Writer_Entry
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Writer
Properties
$_data
$_extensions
$_type
Methods
__construct
addAuthor
addAuthors
setEncoding
getEncoding
setCopyright
setContent
setDateCreated
setDateModified
setDescription
setId
setLink
setCommentCount
setCommentLink
setCommentFeedLink
setCommentFeedLinks
setTitle
getAuthors
getContent
getCopyright
getDateCreated
getDateModified
getDescription
getId
getLink
getLinks
getTitle
getCommentCount
getCommentLink
getCommentFeedLinks
addCategory
addCategories
getCategories
setEnclosure
getEnclosure
remove
getExtensions
getExtension
setType
getType
__call
createSource
setSource
getSource
_loadExtensions

Description

Properties

$_data
jump to class

array $_data = 'array'

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

Details

$_data
array
visibility
protected
default
array
final
false
static
false

$_extensions
jump to class

array $_extensions = 'array'

Registered extensions

Details

$_extensions
array
visibility
protected
default
array
final
false
static
false

$_type
jump to class

string $_type = 'null'

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

Details

$_type
string
visibility
protected
default
null
final
false
static
false

Methods

__call
jump to class

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

Method overloading: call given method on first extension implementing it

Arguments
$method
string
$args
array
Output
mixed
Details
visibility
public
final
false
static
false
throws
if no extensions implements the method

__construct
jump to class

__construct( ) : void

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

Details
visibility
public
final
false
static
false

_loadExtensions
jump to class

_loadExtensions( ) : void

Load extensions from Zend_Feed_Writer

Details
visibility
protected
final
false
static
false

addAuthor
jump to class

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

Set a single author

Arguments
$name
$email
$uri
Output
string|null
Details
visibility
public
final
false
static
false

addAuthors
jump to class

addAuthors(  $authors ) : array

Set an array with feed authors

Arguments
$authors
Output
array
Details
visibility
public
final
false
static
false

addCategories
jump to class

addCategories( array $categories ) :

Set an array of entry categories

Arguments
$categories
array
Details
visibility
public
final
false
static
false

addCategory
jump to class

addCategory( string $category ) :

Add a entry category

Arguments
$category
string
Details
visibility
public
final
false
static
false

createSource
jump to class

createSource( ) : 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.

Output
Zend_Feed_Writer_Source
Details
visibility
public
final
false
static
false

getAuthors
jump to class

getAuthors( ) : array

Get an array with feed authors

Output
array
Details
visibility
public
final
false
static
false

getCategories
jump to class

getCategories( ) : string|null

Get the entry categories

Output
string|null
Details
visibility
public
final
false
static
false

getCommentCount
jump to class

getCommentCount( ) : integer

Get the number of comments/replies for current entry

Output
integer
Details
visibility
public
final
false
static
false

getCommentFeedLinks
jump to class

getCommentFeedLinks( ) : 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).

Output
string
Details
visibility
public
final
false
static
false

getCommentLink
jump to class

getCommentLink( ) : string

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

Output
string
Details
visibility
public
final
false
static
false

getContent
jump to class

getContent( ) : string

Get the entry content

Output
string
Details
visibility
public
final
false
static
false

getCopyright
jump to class

getCopyright( ) : string

Get the entry copyright information

Output
string
Details
visibility
public
final
false
static
false

getDateCreated
jump to class

getDateCreated( ) : string

Get the entry creation date

Output
string
Details
visibility
public
final
false
static
false

getDateModified
jump to class

getDateModified( ) : string

Get the entry modification date

Output
string
Details
visibility
public
final
false
static
false

getDescription
jump to class

getDescription( ) : string

Get the entry description

Output
string
Details
visibility
public
final
false
static
false

getEnclosure
jump to class

getEnclosure( ) : array

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

Output
array
Details
visibility
public
final
false
static
false

getEncoding
jump to class

getEncoding( ) : string|null

Get the feed character encoding

Output
string|null
Details
visibility
public
final
false
static
false

getExtension
jump to class

getExtension( string $name ) : object

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

Arguments
$name
string
Output
object
Details
visibility
public
final
false
static
false

getExtensions
jump to class

getExtensions( ) : array

Get registered extensions

Output
array
Details
visibility
public
final
false
static
false

getId
jump to class

getId( ) : string

Get the entry ID

Output
string
Details
visibility
public
final
false
static
false

getLink
jump to class

getLink( ) : string|null

Get a link to the HTML source

Output
string|null
Details
visibility
public
final
false
static
false

getLinks
jump to class

getLinks( ) : array

Get all links

Output
array
Details
visibility
public
final
false
static
false

getSource
jump to class

getSource( ) : Zend_Feed_Writer_Source

Output
Zend_Feed_Writer_Source
Details
visibility
public
final
false
static
false

getTitle
jump to class

getTitle( ) : string

Get the entry title

Output
string
Details
visibility
public
final
false
static
false

getType
jump to class

getType( ) : string

Retrieve the current or last feed type exported.

Output
string
Value will be "rss" or "atom"
Details
visibility
public
final
false
static
false

remove
jump to class

remove( string $name ) :

Unset a specific data point

Arguments
$name
string
Details
visibility
public
final
false
static
false

setCommentCount
jump to class

setCommentCount(  $count ) : string|null

Set the number of comments associated with this entry

Arguments
$count
Output
string|null
Details
visibility
public
final
false
static
false

setCommentFeedLink
jump to class

setCommentFeedLink(  $link ) : string|null

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

Arguments
$link
Output
string|null
Details
visibility
public
final
false
static
false

setCommentFeedLinks
jump to class

setCommentFeedLinks(  $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".

Arguments
$links
Output
string|null
Details
visibility
public
final
false
static
false

setCommentLink
jump to class

setCommentLink(  $link ) : string|null

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

Arguments
$link
Output
string|null
Details
visibility
public
final
false
static
false

setContent
jump to class

setContent(  $content ) : string|null

Set the entry's content

Arguments
$content
Output
string|null
Details
visibility
public
final
false
static
false

setCopyright
jump to class

setCopyright(  $copyright ) : string|null

Set the copyright entry

Arguments
$copyright
Output
string|null
Details
visibility
public
final
false
static
false

setDateCreated
jump to class

setDateCreated(  $date = null ) : string|null

Set the feed creation date

Arguments
$date
Output
string|null
Details
visibility
public
final
false
static
false

setDateModified
jump to class

setDateModified(  $date = null ) : string|null

Set the feed modification date

Arguments
$date
Output
string|null
Details
visibility
public
final
false
static
false

setDescription
jump to class

setDescription(  $description ) : string|null

Set the feed description

Arguments
$description
Output
string|null
Details
visibility
public
final
false
static
false

setEnclosure
jump to class

setEnclosure(  $enclosure ) :

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.

Arguments
$enclosure
Details
visibility
public
final
false
static
false

setEncoding
jump to class

setEncoding(  $encoding ) : string|null

Set the feed character encoding

Arguments
$encoding
Output
string|null
Details
visibility
public
final
false
static
false

setId
jump to class

setId(  $id ) : string|null

Set the feed ID

Arguments
$id
Output
string|null
Details
visibility
public
final
false
static
false

setLink
jump to class

setLink(  $link ) : string|null

Set a link to the HTML source of this entry

Arguments
$link
Output
string|null
Details
visibility
public
final
false
static
false

setSource
jump to class

setSource( Zend_Feed_Writer_Source $source ) :

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

Arguments
$source
Zend_Feed_Writer_Source
Details
visibility
public
final
false
static
false

setTitle
jump to class

setTitle(  $title ) : string|null

Set the feed title

Arguments
$title
Output
string|null
Details
visibility
public
final
false
static
false

setType
jump to class

setType( string $type ) :

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.

Arguments
$type
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.