Feed/Writer/Source.php

Show: PublicProtectedPrivateinherited
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: Source.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Feed_Writer_Source

Package: Zend\Feed\Writer
Parent(s)
\Zend_Feed_Writer_Feed_FeedAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_data = array()
inherited
Contains all Feed level date to append in feed output
Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::$$_data
Default valuearray()Details
Type
array
Inherited_from
\Zend_Feed_Writer_Feed_FeedAbstract::$$_data  
>VPropertyprotectedstring $_type = null
inherited
Holds the value "atom" or "rss" depending on the feed type set when when last exported.
Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::$$_type
Default valuenullDetails
Type
string
Inherited_from
\Zend_Feed_Writer_Feed_FeedAbstract::$$_type  

Methods

methodpublic__call(string $method, array $args) : mixed
inherited

Method overloading: call given method on first extension implementing it

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::__call()
Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Feed_Exceptionif no extensions implements the method
methodpublic__construct() : void
inherited

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

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::__construct()
methodprotected_loadExtensions() : void
inherited

Load extensions from Zend_Feed_Writer

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::_loadExtensions()
methodprotected_validateTagUri(string $id) : bool
inherited

Validate a URI using the tag scheme (RFC 4151)

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::_validateTagUri()
Parameters
NameTypeDescription
$idstring
Returns
TypeDescription
bool
methodpublicaddAuthor( $name,  $email = null,  $uri = null) : string | null
inherited

Set a single author

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addAuthor()
Parameters
NameTypeDescription
$name
$email
$uri
Returns
TypeDescription
string | null
methodpublicaddAuthors( $authors) : array
inherited

Set an array with feed authors

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addAuthors()
Parameters
NameTypeDescription
$authors
Returns
TypeDescription
array
methodpublicaddCategories(array $categories) : void
inherited

Set an array of feed categories

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addCategories()
Parameters
NameTypeDescription
$categoriesarray
methodpublicaddCategory(string $category) : void
inherited

Add a feed category

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addCategory()
Parameters
NameTypeDescription
$categorystring
methodpublicaddHub(string $url) : void
inherited

Add a Pubsubhubbub hub endpoint URL

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addHub()
Parameters
NameTypeDescription
$urlstring
methodpublicaddHubs(array $urls) : void
inherited

Add Pubsubhubbub hub endpoint URLs

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addHubs()
Parameters
NameTypeDescription
$urlsarray
methodpublicgetAuthor(int $index = 0) : string | null
inherited

Get a single author

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getAuthor()
Parameters
NameTypeDescription
$indexint
Returns
TypeDescription
string | null
methodpublicgetAuthors() : array
inherited

Get an array with feed authors

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getAuthors()
Returns
TypeDescription
array
methodpublicgetBaseUrl() : string | null
inherited

Get the feed's base url

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getBaseUrl()
Returns
TypeDescription
string | null
methodpublicgetCategories() : string | null
inherited

Get the feed categories

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getCategories()
Returns
TypeDescription
string | null
methodpublicgetCopyright() : string | null
inherited

Get the copyright entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getCopyright()
Returns
TypeDescription
string | null
methodpublicgetDateCreated() : string | null
inherited

Get the feed creation date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getDateCreated()
Returns
TypeDescription
string | null
methodpublicgetDateModified() : string | null
inherited

Get the feed modification date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getDateModified()
Returns
TypeDescription
string | null
methodpublicgetDescription() : string | null
inherited

Get the feed description

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getDescription()
Returns
TypeDescription
string | null
methodpublicgetEncoding() : string | null
inherited

Get the feed character encoding

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getEncoding()
Returns
TypeDescription
string | null
methodpublicgetFeedLinks() : string | null
inherited

Get a link to the XML feed

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getFeedLinks()
Returns
TypeDescription
string | null
methodpublicgetGenerator() : string | null
inherited

Get the feed generator entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getGenerator()
Returns
TypeDescription
string | null
methodpublicgetHubs() : string | null
inherited

Get the URLs used as Pubsubhubbub hubs endpoints

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getHubs()
Returns
TypeDescription
string | null
methodpublicgetIcon() : array
inherited

Get the feed icon URI

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getIcon()
Returns
TypeDescription
array
methodpublicgetId() : string | null
inherited

Get the feed ID

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getId()
Returns
TypeDescription
string | null
methodpublicgetImage() : array
inherited

Get the feed image URI

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getImage()
Returns
TypeDescription
array
methodpublicgetLanguage() : string | null
inherited

Get the feed language

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getLanguage()
Returns
TypeDescription
string | null
methodpublicgetLastBuildDate() : string | null
inherited

Get the feed last-build date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getLastBuildDate()
Returns
TypeDescription
string | null
methodpublicgetLink() : string | null
inherited

Get a link to the HTML source

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getLink()
Returns
TypeDescription
string | null
methodpublicgetTitle() : string | null
inherited

Get the feed title

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getTitle()
Returns
TypeDescription
string | null
methodpublicgetType() : string
inherited

Retrieve the current or last feed type exported.

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getType()
Returns
TypeDescription
stringValue will be "rss" or "atom"
methodpublicremove(string $name) : void
inherited

Unset a specific data point

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::remove()
Parameters
NameTypeDescription
$namestring
methodpublicreset() : void
inherited

Resets the instance and deletes all data

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::reset()
methodpublicsetBaseUrl(string $url) : void
inherited

Set the feed's base URL

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setBaseUrl()
Parameters
NameTypeDescription
$urlstring
methodpublicsetCopyright( $copyright) : string | null
inherited

Set the copyright entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setCopyright()
Parameters
NameTypeDescription
$copyright
Returns
TypeDescription
string | null
methodpublicsetDateCreated(null | integer | \Zend_Date $date = null) : void
inherited

Set the feed creation date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setDateCreated()
Parameters
NameTypeDescription
$datenull | integer | \Zend_Date
methodpublicsetDateModified(null | integer | \Zend_Date $date = null) : void
inherited

Set the feed modification date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setDateModified()
Parameters
NameTypeDescription
$datenull | integer | \Zend_Date
methodpublicsetDescription( $description) : string | null
inherited

Set the feed description

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setDescription()
Parameters
NameTypeDescription
$description
Returns
TypeDescription
string | null
methodpublicsetEncoding(string $encoding) : void
inherited

Set the feed character encoding

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setEncoding()
Parameters
NameTypeDescription
$encodingstring
methodpublicsetFeedLink( $link,  $type) : string | null
inherited

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

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setFeedLink()
Parameters
NameTypeDescription
$link
$type
Returns
TypeDescription
string | null
methodpublicsetGenerator( $name,  $version = null,  $uri = null) : string | null
inherited

Set the feed generator entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setGenerator()
Parameters
NameTypeDescription
$name
$version
$uri
Returns
TypeDescription
string | null
methodpublicsetIcon(array $data) : void
inherited

Set a feed icon (URI at minimum).

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setIcon()

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
NameTypeDescription
$dataarray
methodpublicsetId(string $id) : void
inherited

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

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setId()
Parameters
NameTypeDescription
$idstring
methodpublicsetImage(array $data) : void
inherited

Set a feed image (URI at minimum).

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setImage()

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
NameTypeDescription
$dataarray
methodpublicsetLanguage( $language) : string | null
inherited

Set the feed language

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setLanguage()
Parameters
NameTypeDescription
$language
Returns
TypeDescription
string | null
methodpublicsetLastBuildDate(null | integer | \Zend_Date $date = null) : void
inherited

Set the feed last-build date.

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setLastBuildDate()

Ignored for Atom 1.0.

Parameters
NameTypeDescription
$datenull | integer | \Zend_Date
methodpublicsetLink(string $link) : void
inherited

Set a link to the HTML source

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setLink()
Parameters
NameTypeDescription
$linkstring
methodpublicsetTitle( $title) : string | null
inherited

Set the feed title

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setTitle()
Parameters
NameTypeDescription
$title
Returns
TypeDescription
string | null
methodpublicsetType(string $type) : void
inherited

Set the current feed type being exported to "rss" or "atom".

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setType()

This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.

Parameters
NameTypeDescription
$typestring
Documentation was generated by phpDocumentor 2.0.0a12.