package Default

 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\Writer\Exception\BadMethodCallException 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() 

Set a single author

addAuthor(array $author) : \Zend\Feed\Writer\AbstractFeed

The following option keys are supported: 'name' => (string) The name 'email' => (string) An optional email 'uri' => (string) An optional and valid URI

Parameters

$author

array

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException If any value of $author not follow the format.

Returns

\Zend\Feed\Writer\AbstractFeed

Set an array with feed authors

addAuthors(array $authors) : \Zend\Feed\Writer\AbstractFeed
see

Parameters

$authors

array

Returns

\Zend\Feed\Writer\AbstractFeed

Set an array of feed categories

addCategories(array $categories) : \Zend\Feed\Writer\AbstractFeed

Parameters

$categories

array

Returns

\Zend\Feed\Writer\AbstractFeed

Add a feed category

addCategory(array $category) : \Zend\Feed\Writer\AbstractFeed

Parameters

$category

array

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Add a Pubsubhubbub hub endpoint URL

addHub(string $url) : \Zend\Feed\Writer\AbstractFeed

Parameters

$url

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Add Pubsubhubbub hub endpoint URLs

addHubs(array $urls) : \Zend\Feed\Writer\AbstractFeed

Parameters

$urls

array

Returns

\Zend\Feed\Writer\AbstractFeed

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 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) : \Zend\Feed\Writer\AbstractFeed

Parameters

$name

string

Returns

\Zend\Feed\Writer\AbstractFeed

Resets the instance and deletes all data

reset() : void

Set the feed's base URL

setBaseUrl(string $url) : \Zend\Feed\Writer\AbstractFeed

Parameters

$url

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the copyright entry

setCopyright(string $copyright) : \Zend\Feed\Writer\AbstractFeed

Parameters

$copyright

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the feed creation date

setDateCreated($date = null) : \Zend\Feed\Writer\AbstractFeed

Parameters

$date

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the feed modification date

setDateModified($date = null) : \Zend\Feed\Writer\AbstractFeed

Parameters

$date

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the feed description

setDescription(string $description) : \Zend\Feed\Writer\AbstractFeed

Parameters

$description

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the feed character encoding

setEncoding(string $encoding) : \Zend\Feed\Writer\AbstractFeed

Parameters

$encoding

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the feed generator entry

setGenerator(array|string $name, null|string $version = null, null|string $uri = null) : \Zend\Feed\Writer\AbstractFeed

Parameters

$name

arraystring

$version

nullstring

$uri

nullstring

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

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

setId(string $id) : \Zend\Feed\Writer\AbstractFeed

Parameters

$id

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

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) : \Zend\Feed\Writer\AbstractFeed

Parameters

$data

array

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the feed language

setLanguage(string $language) : \Zend\Feed\Writer\AbstractFeed

Parameters

$language

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

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

setLastBuildDate($date = null) : \Zend\Feed\Writer\AbstractFeed

Parameters

$date

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

Set the feed title

setTitle(string $title) : \Zend\Feed\Writer\AbstractFeed

Parameters

$title

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

\Zend\Feed\Writer\AbstractFeed

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) : \Zend\Feed\Writer\AbstractFeed

Parameters

$type

string

Returns

\Zend\Feed\Writer\AbstractFeed

Load extensions from Zend\Feed\Writer\Writer

_loadExtensions() : void

Exceptions

\Zend\Feed\Writer\Exception\RuntimeException

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

$extensions

$extensions : 

Default

 

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

$type : string

Default

null