Feed/Writer/Feed/FeedAbstract.php

Show:

inherited

Classes
- \Zend_Feed_Writer_Feed_FeedAbstract

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Feed_Writer
Version: $Id$

\Zend_Feed_Writer_Feed_FeedAbstract
jump to top

Package: Zend_Feed_Writer

Children: \Zend_Feed_Writer_Feed; \Zend_Feed_Writer_Source
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_data = array()

Contains all Feed level date to append in feed output

Default valuearray()Details

Type: array

string $_type = null

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

Default valuenullDetails

Type: string

Methods

__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

__construct() : void

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

_loadExtensions() : void

Load extensions from Zend_Feed_Writer

_validateTagUri(string $id) : bool

Validate a URI using the tag scheme (RFC 4151)

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
bool

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

Set a single author

Parameters

Name	Type	Description
$name
$email
$uri

Returns

Type	Description
string \| null

addAuthors( $authors) : array

Set an array with feed authors

Parameters

Name	Type	Description
$authors

Returns

Type	Description
array

addCategories(array $categories) : void

Set an array of feed categories

Parameters

Name	Type	Description
$categories	array

addCategory(string $category) : void

Add a feed category

Parameters

Name	Type	Description
$category	string

addHub(string $url) : void

Add a Pubsubhubbub hub endpoint URL

Parameters

Name	Type	Description
$url	string

addHubs(array $urls) : void

Add Pubsubhubbub hub endpoint URLs

Parameters

Name	Type	Description
$urls	array

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

Get a single 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 feed's base url

Returns

Type	Description
string \| null

getCategories() : string | null

Get the feed categories

Returns

Type	Description
string \| null

getCopyright() : string | null

Get the copyright entry

Returns

Type	Description
string \| null

getDateCreated() : string | null

Get the feed creation date

Returns

Type	Description
string \| null

getDateModified() : string | null

Get the feed modification date

Returns

Type	Description
string \| null

getDescription() : string | null

Get the feed description

Returns

Type	Description
string \| null

getEncoding() : string | null

Get the feed character encoding

Returns

Type	Description
string \| null

getFeedLinks() : string | null

Get a link to the XML feed

Returns

Type	Description
string \| null

getGenerator() : string | null

Get the feed generator entry

Returns

Type	Description
string \| null

getHubs() : string | null

Get the URLs used as Pubsubhubbub hubs endpoints

Returns

Type	Description
string \| null

getIcon() : array

Get the feed icon URI

Returns

Type	Description
array

getId() : string | null

Get the feed ID

Returns

Type	Description
string \| null

getImage() : array

Get the feed image URI

Returns

Type	Description
array

getLanguage() : string | null

Get the feed language

Returns

Type	Description
string \| null

getLastBuildDate() : string | null

Get the feed last-build date

Returns

Type	Description
string \| null

getLink() : string | null

Get a link to the HTML source

Returns

Type	Description
string \| null

getTitle() : string | null

Get the feed title

Returns

Type	Description
string \| null

getType() : string

Retrieve the current or last feed type exported.

Returns

Type	Description
string	Value will be "rss" or "atom"

remove(string $name) : void

Unset a specific data point

Parameters

Name	Type	Description
$name	string

reset() : void

Resets the instance and deletes all data

setBaseUrl(string $url) : void

Set the feed's base URL

Parameters

Name	Type	Description
$url	string

setCopyright( $copyright) : string | null

Set the copyright entry

Parameters

Name	Type	Description
$copyright

Returns

Type	Description
string \| null

setDateCreated( $date = null) : void

Set the feed creation date

Parameters

Name	Type	Description
$date

setDateModified( $date = null) : void

Set the feed modification date

Parameters

Name	Type	Description
$date

setDescription( $description) : string | null

Set the feed description

Parameters

Name	Type	Description
$description

Returns

Type	Description
string \| null

setEncoding(string $encoding) : void

Set the feed character encoding

Parameters

Name	Type	Description
$encoding	string

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

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

Parameters

Name	Type	Description
$link
$type

Returns

Type	Description
string \| null

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

Set the feed generator entry

Parameters

Name	Type	Description
$name
$version
$uri

Returns

Type	Description
string \| null

setIcon(array $data) : void

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.

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

Parameters

Name	Type	Description
$data	array

setId(string $id) : void

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

Parameters

Name	Type	Description
$id	string

setImage(array $data) : void

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.

Parameters

Name	Type	Description
$data	array

setLanguage( $language) : string | null

Set the feed language

Parameters

Name	Type	Description
$language

Returns

Type	Description
string \| null

setLastBuildDate( $date = null) : void

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

Parameters

Name	Type	Description
$date

setLink(string $link) : void

Set a link to the HTML source

Parameters

Name	Type	Description
$link	string

setTitle( $title) : string | null

Set the feed title

Parameters

Name	Type	Description
$title

Returns

Type	Description
string \| null

setType(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

Feed/Writer/Feed/FeedAbstract.php

\Zend_Feed_Writer_Feed_FeedAbstractjump to top

Properties

Methods

\Zend_Feed_Writer_Feed_FeedAbstract
jump to top