category Zend
package Zend_Feed_Writer
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Method overloading: call given method on first extension implementing it

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

Parameters

$method

string

$args

array

Exceptions

\Zend_Feed_Exception if no extensions implements the method

Returns

mixed

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

__construct() : void

Set a single author

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

Parameters

$name

$email

$uri

Returns

stringnull

Set an array with feed authors

addAuthors(array $authors) : array

Parameters

$authors

Returns

array

Set an array of feed categories

addCategories(array $categories) 

Parameters

$categories

array

Add a feed category

addCategory(string $category) 

Parameters

$category

string

Add a Pubsubhubbub hub endpoint URL

addHub(string $url) 

Parameters

$url

string

Add Pubsubhubbub hub endpoint URLs

addHubs(array $urls) 

Parameters

$urls

array

Get a single author

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

Parameters

$index

integer

Returns

stringnull

Get an array with feed authors

getAuthors() : array

Returns

array

Get the feed's base url

getBaseUrl() : string | null

Returns

stringnull

Get the feed categories

getCategories() : string | null

Returns

stringnull

Get the copyright entry

getCopyright() : string | null

Returns

stringnull

Get the feed creation date

getDateCreated() : string | null

Returns

stringnull

Get the feed modification date

getDateModified() : string | null

Returns

stringnull

Get the feed description

getDescription() : string | null

Returns

stringnull

Get the feed character encoding

getEncoding() : string | null

Returns

stringnull

Get the feed generator entry

getGenerator() : string | null

Returns

stringnull

Get the URLs used as Pubsubhubbub hubs endpoints

getHubs() : string | null

Returns

stringnull

Get the feed icon URI

getIcon() : array

Returns

array

Get the feed ID

getId() : string | null

Returns

stringnull

Get the feed image URI

getImage() : array

Returns

array

Get the feed language

getLanguage() : string | null

Returns

stringnull

Get the feed last-build date

getLastBuildDate() : string | null

Returns

stringnull

Get the feed title

getTitle() : string | null

Returns

stringnull

Retrieve the current or last feed type exported.

getType() : string

Returns

stringValue will be "rss" or "atom"

Unset a specific data point

remove(string $name) 

Parameters

$name

string

Resets the instance and deletes all data

reset() : void

Set the feed's base URL

setBaseUrl(string $url) 

Parameters

$url

string

Set the copyright entry

setCopyright($copyright) : string | null

Parameters

$copyright

Returns

stringnull

Set the feed creation date

setDateCreated($date = null

Parameters

$date

Set the feed modification date

setDateModified($date = null

Parameters

$date

Set the feed description

setDescription($description) : string | null

Parameters

$description

Returns

stringnull

Set the feed character encoding

setEncoding(string $encoding) 

Parameters

$encoding

string

Set the feed generator entry

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

Parameters

$name

$version

$uri

Returns

stringnull

Set a feed icon (URI at minimum). Parameter is a single array with the required key 'uri'. Only 'uri' is required and used for Atom rendering.

setIcon(array $data) 

RSS does not support an Icon tag except via Atom 1.0 as an extension.

Parameters

$data

array

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

setId(string $id) 

Parameters

$id

string

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.

setImage(array $data) 

Parameters

$data

array

Set the feed language

setLanguage($language) : string | null

Parameters

$language

Returns

stringnull

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

setLastBuildDate($date = null

Parameters

$date

Set the feed title

setTitle($title) : string | null

Parameters

$title

Returns

stringnull

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.

setType(string $type) 

Parameters

$type

string

Load extensions from Zend_Feed_Writer

_loadExtensions() : void

Validate a URI using the tag scheme (RFC 4151)

_validateTagUri(string $id) : boolean

Parameters

$id

string

Returns

boolean

 Properties

 

Contains all Feed level date to append in feed output

$_data : array

Default

array()
 

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

$_type : string

Default

null