API Documentation

Feed/Writer/Feed/FeedAbstract.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: Feed.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Feed_Writer_Feed_FeedAbstract

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_Feed_FeedAbstract
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
$_type
Methods
__construct
addAuthor
addAuthors
setCopyright
setDateCreated
setDateModified
setLastBuildDate
setDescription
setGenerator
setId
_validateTagUri
setImage
setLanguage
setLink
setFeedLink
setTitle
setEncoding
setBaseUrl
addHub
addHubs
addCategory
addCategories
getAuthor
getAuthors
getCopyright
getDateCreated
getDateModified
getLastBuildDate
getDescription
getGenerator
getId
getImage
getLanguage
getLink
getFeedLinks
getTitle
getEncoding
getBaseUrl
getHubs
getCategories
reset
setType
getType
remove
__call
_loadExtensions

Description

Properties

$_data
jump to class

array $_data = 'array'

Contains all Feed level date to append in feed output

Details

$_data
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

_validateTagUri
jump to class

_validateTagUri( string $id ) : bool

Validate a URI using the tag scheme (RFC 4151)

Arguments
$id
string
Output
bool
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 feed categories

Arguments
$categories
array
Details
visibility
public
final
false
static
false

addCategory
jump to class

addCategory( string $category ) :

Add a feed category

Arguments
$category
string
Details
visibility
public
final
false
static
false

addHub
jump to class

addHub( string $url ) :

Add a Pubsubhubbub hub endpoint URL

Arguments
$url
string
Details
visibility
public
final
false
static
false

addHubs
jump to class

addHubs( array $urls ) :

Add Pubsubhubbub hub endpoint URLs

Arguments
$urls
array
Details
visibility
public
final
false
static
false

getAuthor
jump to class

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

Get a single author

Arguments
$index
int
Output
string|null
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

getBaseUrl
jump to class

getBaseUrl( ) : string|null

Get the feed's base url

Output
string|null
Details
visibility
public
final
false
static
false

getCategories
jump to class

getCategories( ) : string|null

Get the feed categories

Output
string|null
Details
visibility
public
final
false
static
false

getCopyright
jump to class

getCopyright( ) : string|null

Get the copyright entry

Output
string|null
Details
visibility
public
final
false
static
false

getDateCreated
jump to class

getDateCreated( ) : string|null

Get the feed creation date

Output
string|null
Details
visibility
public
final
false
static
false

getDateModified
jump to class

getDateModified( ) : string|null

Get the feed modification date

Output
string|null
Details
visibility
public
final
false
static
false

getDescription
jump to class

getDescription( ) : string|null

Get the feed description

Output
string|null
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

getFeedLinks
jump to class

getFeedLinks( ) : string|null

Get a link to the XML feed

Output
string|null
Details
visibility
public
final
false
static
false

getGenerator
jump to class

getGenerator( ) : string|null

Get the feed generator entry

Output
string|null
Details
visibility
public
final
false
static
false

getHubs
jump to class

getHubs( ) : string|null

Get the URLs used as Pubsubhubbub hubs endpoints

Output
string|null
Details
visibility
public
final
false
static
false

getId
jump to class

getId( ) : string|null

Get the feed ID

Output
string|null
Details
visibility
public
final
false
static
false

getImage
jump to class

getImage( ) : array

Get the feed image URI

Output
array
Details
visibility
public
final
false
static
false

getLanguage
jump to class

getLanguage( ) : string|null

Get the feed language

Output
string|null
Details
visibility
public
final
false
static
false

getLastBuildDate
jump to class

getLastBuildDate( ) : string|null

Get the feed last-build date

Output
string|null
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

getTitle
jump to class

getTitle( ) : string|null

Get the feed title

Output
string|null
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

reset
jump to class

reset( ) : void

Resets the instance and deletes all data

Details
visibility
public
final
false
static
false

setBaseUrl
jump to class

setBaseUrl( string $url ) :

Set the feed's base URL

Arguments
$url
string
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 ) :

Set the feed creation date

Arguments
$date
null|integer|Zend_Date
Details
visibility
public
final
false
static
false

setDateModified
jump to class

setDateModified(  $date = null ) :

Set the feed modification date

Arguments
$date
null|integer|Zend_Date
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

setEncoding
jump to class

setEncoding( string $encoding ) :

Set the feed character encoding

Arguments
$encoding
string
Details
visibility
public
final
false
static
false

setFeedLink
jump to class

setFeedLink(  $link,  $type ) : string|null

Set a link to an XML feed for any feed type/version

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

setGenerator
jump to class

setGenerator(  $name,  $version = null,  $uri = null ) : string|null

Set the feed generator entry

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

setId
jump to class

setId( string $id ) :

Set the feed ID - URI or URN (via PCRE pattern) supported

Arguments
$id
string
Details
visibility
public
final
false
static
false

setImage
jump to class

setImage( array $data ) :

Set a feed image (URI at minimum). Parameter is a single array with the required key 'uri'. When rendering as RSS, the required keys are 'uri', 'title' and 'link'. RSS also specifies three optional parameters 'width', 'height' and 'description'. Only 'uri' is required and used for Atom rendering.

Arguments
$data
array
Details
visibility
public
final
false
static
false

setLanguage
jump to class

setLanguage(  $language ) : string|null

Set the feed language

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

setLastBuildDate
jump to class

setLastBuildDate(  $date = null ) :

Set the feed last-build date. Ignored for Atom 1.0.

Arguments
$date
null|integer|Zend_Date
Details
visibility
public
final
false
static
false

setLink
jump to class

setLink( string $link ) :

Set a link to the HTML source

Arguments
$link
string
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.