Methods

Method overloading: call given method on first extension implementing it

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

inherited_from \Zend\Feed\Writer\AbstractFeed::__call()

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

inherited_from \Zend\Feed\Writer\AbstractFeed::__construct()

Set a single author

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

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

inherited_from \Zend\Feed\Writer\AbstractFeed::addAuthor()

Parameters

$author

array

Exceptions

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

Returns

Set an array with feed authors

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

see \Zend\Feed\Writer\addAuthor
inherited_from \Zend\Feed\Writer\AbstractFeed::addAuthors()

Parameters

$authors

array

Returns

Set an array of feed categories

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

inherited_from \Zend\Feed\Writer\AbstractFeed::addCategories()

Parameters

$categories

array

Returns

Add a feed category

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

inherited_from \Zend\Feed\Writer\AbstractFeed::addCategory()

Parameters

$category

array

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Appends a Zend\Feed\Writer\Entry object representing a new entry/item the feed data container's internal group of entries.

addEntry(\Zend\Feed\Writer\Entry $entry) : \Zend\Feed\Writer\Feed

Add a Pubsubhubbub hub endpoint URL

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

inherited_from \Zend\Feed\Writer\AbstractFeed::addHub()

Parameters

$url

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Add Pubsubhubbub hub endpoint URLs

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

inherited_from \Zend\Feed\Writer\AbstractFeed::addHubs()

Parameters

$urls

array

Returns

Appends a Zend\Feed\Writer\Deleted object representing a new entry tombstone to the feed data container's internal group of entries.

addTombstone(\Zend\Feed\Writer\Deleted $deleted) : void

Parameters

Get the number of feed entries.

count() : int

Required by the Iterator interface.

Returns

int

Creates a new Zend\Feed\Writer\Entry data container for use.

createEntry() : \Zend\Feed\Writer\Entry

This is NOT added to the current feed automatically, but is necessary to create a container with some initial values preset based on the current feed data.

Returns

Creates a new Zend\Feed\Writer\Deleted data container for use.

createTombstone() : \Zend\Feed\Writer\Deleted

This is NOT added to the current feed automatically, but is necessary to create a container with some initial values preset based on the current feed data.

Returns

Return the current entry

current() : \Zend\Feed\Writer\Entry

Attempt to build and return the feed resulting from the data set

export(string $type, bool $ignoreExceptions) : string

Parameters

$type

string

The feed type "rss" or "atom" to export as

$ignoreExceptions

bool

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

string

Get a single author

getAuthor(int $index) : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getAuthor()

Parameters

$index

int

Returns

stringnull

Get an array with feed authors

getAuthors() : array
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getAuthors()

Returns

array

Get the feed's base url

getBaseUrl() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getBaseUrl()

Returns

stringnull

Get the feed categories

getCategories() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getCategories()

Returns

stringnull

Get the copyright entry

getCopyright() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getCopyright()

Returns

stringnull

Get the feed creation date

getDateCreated() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getDateCreated()

Returns

stringnull

Get the feed modification date

getDateModified() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getDateModified()

Returns

stringnull

Get the feed description

getDescription() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getDescription()

Returns

stringnull

Get the feed character encoding

getEncoding() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getEncoding()

Returns

stringnull

Retrieve a specific indexed entry from the internal queue.

getEntry(int $index) 

Entries must be added to a feed container in order to be indexed.

Parameters

$index

int

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Get the feed generator entry

getGenerator() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getGenerator()

Returns

stringnull

Get the URLs used as Pubsubhubbub hubs endpoints

getHubs() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getHubs()

Returns

stringnull

Get the feed ID

getId() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getId()

Returns

stringnull

Get the feed image URI

getImage() : array
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getImage()

Returns

array

Get the feed language

getLanguage() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getLanguage()

Returns

stringnull

Get the feed last-build date

getLastBuildDate() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getLastBuildDate()

Returns

stringnull

Get the feed title

getTitle() : string | null
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getTitle()

Returns

stringnull

Retrieve the current or last feed type exported.

getType() : string
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::getType()

Returns

stringValue will be "rss" or "atom"

Return the current feed key

key() : mixed

Returns

mixed

Orders all indexed entries by date, thus offering date ordered readable content where a parser (or Homo Sapien) ignores the generic rule that XML element order is irrelevant and has no intrinsic meaning.

orderByDate() : \Zend\Feed\Writer\Feed

Using this method will alter the original indexation.

Returns

Unset a specific data point

remove(string $name) : \Zend\Feed\Writer\AbstractFeed
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::remove()

Parameters

$name

string

Returns

Removes a specific indexed entry from the internal queue.

removeEntry(int $index) : \Zend\Feed\Writer\Feed

Entries must be added to a feed container in order to be indexed.

Parameters

$index

int

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Resets the instance and deletes all data

reset() : void
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::reset()

Reset the pointer in the feed object

rewind() : void

Set the feed's base URL

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setBaseUrl()

Parameters

$url

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the copyright entry

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setCopyright()

Parameters

$copyright

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed creation date

setDateCreated($date) : \Zend\Feed\Writer\AbstractFeed
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::setDateCreated()

Parameters

$date

null|integer|DateTime

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed modification date

setDateModified($date) : \Zend\Feed\Writer\AbstractFeed
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::setDateModified()

Parameters

$date

null|integer|DateTime

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed description

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setDescription()

Parameters

$description

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed character encoding

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setEncoding()

Parameters

$encoding

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed generator entry

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setGenerator()

Parameters

$name

arraystring

$version

nullstring

$uri

nullstring

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

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

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setId()

Parameters

$id

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set a feed image (URI at minimum).

setImage(array $data) : \Zend\Feed\Writer\AbstractFeed
Inherited

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.

inherited_from \Zend\Feed\Writer\AbstractFeed::setImage()

Parameters

$data

array

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed language

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setLanguage()

Parameters

$language

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed last-build date.

setLastBuildDate($date) : \Zend\Feed\Writer\AbstractFeed
Inherited

Ignored for Atom 1.0.

inherited_from \Zend\Feed\Writer\AbstractFeed::setLastBuildDate()

Parameters

$date

null|integer|DateTime

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

Set the feed title

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setTitle()

Parameters

$title

string

Exceptions

\Zend\Feed\Writer\Exception\InvalidArgumentException

Returns

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

setType(string $type) : \Zend\Feed\Writer\AbstractFeed
Inherited

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

inherited_from \Zend\Feed\Writer\AbstractFeed::setType()

Parameters

$type

string

Returns

Check to see if the iterator is still valid

valid() : bool

Returns

bool

Load extensions from Zend_Feed_Writer

_loadExtensions() : void
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::_loadExtensions()

Exceptions

\Zend\Feed\Writer\Exception\RuntimeException

Validate a URI using the tag scheme (RFC 4151)

_validateTagUri(string $id) : bool
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::_validateTagUri()

Parameters

$id

string

Returns

bool

 Properties

 

Contains all Feed level date to append in feed output

$data : array
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::$$data
 

Contains all entry objects

$entries : array

 

A pointer for the iterator to keep track of the entries array

$entriesKey : int

 

$extensions

$extensions : \Zend\Feed\Writer\$extensions
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::$$extensions
 

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

$type : string
Inherited

inherited_from \Zend\Feed\Writer\AbstractFeed::$$type