API Documentation

Zend/Feed/Writer/Feed/FeedAbstract.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: FeedAbstract.php 25159 2012-12-18 15:11:06Z matthew $  

\Zend_Feed_Writer_Feed_FeedAbstract

Package: Zend\Feed\Writer

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

Properties

Propertyprotectedarray  $_data= 'array()'

Contains all Feed level date to append in feed output

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

methodprotected_validateTagUri( string $id ) : bool

Validate a URI using the tag scheme (RFC 4151)

Parameters
Name Type Description
$id string
Returns
Type Description
bool
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 feed categories

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

Add a feed category

Parameters
Name Type Description
$category string
methodpublicaddHub( string $url ) : void

Add a Pubsubhubbub hub endpoint URL

Parameters
Name Type Description
$url string
methodpublicaddHubs( array $urls ) : void

Add Pubsubhubbub hub endpoint URLs

Parameters
Name Type Description
$urls array
methodpublicgetAuthor( int $index = 0 ) : string|null

Get a single author

Parameters
Name Type Description
$index int
Returns
Type Description
string|null
methodpublicgetAuthors( ) : array

Get an array with feed authors

Returns
Type Description
array
methodpublicgetBaseUrl( ) : string|null

Get the feed's base url

Returns
Type Description
string|null
methodpublicgetCategories( ) : string|null

Get the feed categories

Returns
Type Description
string|null
methodpublicgetCopyright( ) : string|null

Get the copyright entry

Returns
Type Description
string|null
methodpublicgetDateCreated( ) : string|null

Get the feed creation date

Returns
Type Description
string|null
methodpublicgetDateModified( ) : string|null

Get the feed modification date

Returns
Type Description
string|null
methodpublicgetDescription( ) : string|null

Get the feed description

Returns
Type Description
string|null
methodpublicgetEncoding( ) : string|null

Get the feed character encoding

Returns
Type Description
string|null
methodpublicgetFeedLinks( ) : string|null

Get a link to the XML feed

Returns
Type Description
string|null
methodpublicgetGenerator( ) : string|null

Get the feed generator entry

Returns
Type Description
string|null
methodpublicgetHubs( ) : string|null

Get the URLs used as Pubsubhubbub hubs endpoints

Returns
Type Description
string|null
methodpublicgetIcon( ) : array

Get the feed icon URI

Returns
Type Description
array
methodpublicgetId( ) : string|null

Get the feed ID

Returns
Type Description
string|null
methodpublicgetImage( ) : array

Get the feed image URI

Returns
Type Description
array
methodpublicgetLanguage( ) : string|null

Get the feed language

Returns
Type Description
string|null
methodpublicgetLastBuildDate( ) : string|null

Get the feed last-build date

Returns
Type Description
string|null
methodpublicgetLink( ) : string|null

Get a link to the HTML source

Returns
Type Description
string|null
methodpublicgetTitle( ) : string|null

Get the feed title

Returns
Type Description
string|null
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
methodpublicreset( ) : void

Resets the instance and deletes all data

methodpublicsetBaseUrl( string $url ) : void

Set the feed's base URL

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

Set the copyright entry

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

Set the feed creation date

Parameters
Name Type Description
$date

null|integer|Zend_Date

methodpublicsetDateModified(  $date = null ) : void

Set the feed modification date

Parameters
Name Type Description
$date

null|integer|Zend_Date

methodpublicsetDescription(  $description ) : string|null

Set the feed description

Parameters
Name Type Description
$description
Returns
Type Description
string|null
methodpublicsetEncoding( string $encoding ) : void

Set the feed character encoding

Parameters
Name Type Description
$encoding string
methodpublicsetFeedLink(  $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
methodpublicsetGenerator(  $name,  $version = null,  $uri = null ) : string|null

Set the feed generator entry

Parameters
Name Type Description
$name
$version
$uri
Returns
Type Description
string|null
methodpublicsetIcon( 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
methodpublicsetId( string $id ) : void

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

Parameters
Name Type Description
$id string
methodpublicsetImage( 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
methodpublicsetLanguage(  $language ) : string|null

Set the feed language

Parameters
Name Type Description
$language
Returns
Type Description
string|null
methodpublicsetLastBuildDate(  $date = null ) : void

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

Parameters
Name Type Description
$date

null|integer|Zend_Date

methodpublicsetLink( string $link ) : void

Set a link to the HTML source

Parameters
Name Type Description
$link string
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.