Methods
Method overloading: call given method on first extension implementing it
__call(string $method, array $args) : mixed
Parameters
$method
string
$args
array
Exceptions
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
Returns
Set an array with feed authors
addAuthors(array $authors) : \Zend\Feed\Writer\AbstractFeed
see |
\Zend\Feed\Writer\addAuthor |
Parameters
$authors
array
Returns
Get a single author
getAuthor(int $index) : string | null
Parameters
$index
int
Returns
string
null
Get an array with feed authors
getAuthors() : array
Get the feed's base url
getBaseUrl() : string | null
Get the feed categories
getCategories() : string | null
Get the copyright entry
getCopyright() : string | null
Get the feed creation date
getDateCreated() : string | null
Get the feed modification date
getDateModified() : string | null
Get the feed description
getDescription() : string | null
Get the feed character encoding
getEncoding() : string | null
Get a link to the XML feed
getFeedLinks() : string | null
Get the feed generator entry
getGenerator() : string | null
Get the URLs used as Pubsubhubbub hubs endpoints
getHubs() : string | null
Get the feed ID
getId() : string | null
Get the feed image URI
getImage() : array
Get the feed language
getLanguage() : string | null
Get the feed last-build date
getLastBuildDate() : string | null
Get a link to the HTML source
getLink() : string | null
Get the feed title
getTitle() : string | null
Retrieve the current or last feed type exported.
getType() : string
Returns
string
Value will be "rss" or "atom"
Resets the instance and deletes all data
reset() : void
Set a link to an XML feed for any feed type/version
setFeedLink(string $link, string $type) : \Zend\Feed\Writer\AbstractFeed
Parameters
$link
string
$type
string
Exceptions
Returns
Set the feed generator entry
setGenerator(array | string $name, null | string $version, null | string $uri) : \Zend\Feed\Writer\AbstractFeed
Parameters
$name
arraystring
$version
nullstring
$uri
nullstring
Exceptions
Returns
Set a feed image (URI at minimum).
setImage(array $data) : \Zend\Feed\Writer\AbstractFeed
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
$data
array
Exceptions
Returns
Set the current feed type being exported to "rss" or "atom".
setType(string $type) : \Zend\Feed\Writer\AbstractFeed
This allows
other objects to gracefully choose whether to execute or not, depending
on their appropriateness for the current type, e.g. renderers.
Parameters
$type
string
Returns
Load extensions from Zend\Feed\Writer\Writer
_loadExtensions() : void
Validate a URI using the tag scheme (RFC 4151)
_validateTagUri(string $id) : bool
Parameters
$id
string
Returns
bool
Properties
Contains all Feed level date to append in feed output
$data : array
$extensions
$extensions : \Zend\Feed\Writer\$extensions
Holds the value "atom" or "rss" depending on the feed type set when
when last exported.
$type : string