Zend Framework
3.0
|
Public Member Functions | |
__construct () | |
Constructor: Primarily triggers the registration of core extensions and loads those appropriate to this data container. | |
addAuthor (array $author) | |
Set a single author. | |
addAuthors (array $authors) | |
Set an array with feed authors. | |
setCopyright ($copyright) | |
Set the copyright entry. | |
setDateCreated ($date=null) | |
Set the feed creation date. | |
setDateModified ($date=null) | |
Set the feed modification date. | |
setLastBuildDate ($date=null) | |
Set the feed last-build date. | |
setDescription ($description) | |
Set the feed description. | |
setGenerator ($name, $version=null, $uri=null) | |
Set the feed generator entry. | |
setId ($id) | |
Set the feed ID - URI or URN (via PCRE pattern) supported. | |
setImage (array $data) | |
Set a feed image (URI at minimum). | |
setLanguage ($language) | |
Set the feed language. | |
setLink ($link) | |
Set a link to the HTML source. | |
setFeedLink ($link, $type) | |
Set a link to an XML feed for any feed type/version. | |
setTitle ($title) | |
Set the feed title. | |
setEncoding ($encoding) | |
Set the feed character encoding. | |
setBaseUrl ($url) | |
Set the feed's base URL. | |
addHub ($url) | |
Add a Pubsubhubbub hub endpoint URL. | |
addHubs (array $urls) | |
Add Pubsubhubbub hub endpoint URLs. | |
addCategory (array $category) | |
Add a feed category. | |
addCategories (array $categories) | |
Set an array of feed categories. | |
getAuthor ($index=0) | |
Get a single author. | |
getAuthors () | |
Get an array with feed authors. | |
getCopyright () | |
Get the copyright entry. | |
getDateCreated () | |
Get the feed creation date. | |
getDateModified () | |
Get the feed modification date. | |
getLastBuildDate () | |
Get the feed last-build date. | |
getDescription () | |
Get the feed description. | |
getGenerator () | |
Get the feed generator entry. | |
getId () | |
Get the feed ID. | |
getImage () | |
Get the feed image URI. | |
getLanguage () | |
Get the feed language. | |
getLink () | |
Get a link to the HTML source. | |
getFeedLinks () | |
Get a link to the XML feed. | |
getTitle () | |
Get the feed title. | |
getEncoding () | |
Get the feed character encoding. | |
getBaseUrl () | |
Get the feed's base url. | |
getHubs () | |
Get the URLs used as Pubsubhubbub hubs endpoints. | |
getCategories () | |
Get the feed categories. | |
reset () | |
Resets the instance and deletes all data. | |
setType ($type) | |
Set the current feed type being exported to "rss" or "atom". | |
getType () | |
Retrieve the current or last feed type exported. | |
remove ($name) | |
Unset a specific data point. | |
__call ($method, $args) | |
Method overloading: call given method on first extension implementing it. | |
Protected Member Functions | |
_validateTagUri ($id) | |
Validate a URI using the tag scheme (RFC 4151) | |
_loadExtensions () | |
Load extensions from Zend. | |
Protected Attributes | |
$data = [] | |
$type = null | |
$extensions | |
__construct | ( | ) |
Constructor: Primarily triggers the registration of core extensions and loads those appropriate to this data container.
__call | ( | $method, | |
$args | |||
) |
Method overloading: call given method on first extension implementing it.
string | $method | |
array | $args |
Exception\BadMethodCallException | if no extensions implements the method |
|
protected |
|
protected |
Validate a URI using the tag scheme (RFC 4151)
string | $id |
addAuthor | ( | array | $author | ) |
Set a single author.
The following option keys are supported: 'name' => (string) The name 'email' => (string) An optional email 'uri' => (string) An optional and valid URI
array | $author |
Exception\InvalidArgumentException | If any value of $author not follow the format. |
addAuthors | ( | array | $authors | ) |
addCategories | ( | array | $categories | ) |
addCategory | ( | array | $category | ) |
Add a feed category.
array | $category |
Exception\InvalidArgumentException |
addHub | ( | $url | ) |
Add a Pubsubhubbub hub endpoint URL.
string | $url |
Exception\InvalidArgumentException |
addHubs | ( | array | $urls | ) |
getAuthor | ( | $index = 0 | ) |
Get a single author.
int | $index |
getAuthors | ( | ) |
Get an array with feed authors.
getBaseUrl | ( | ) |
Get the feed's base url.
getCategories | ( | ) |
Get the feed categories.
getCopyright | ( | ) |
Get the copyright entry.
getDateCreated | ( | ) |
Get the feed creation date.
getDateModified | ( | ) |
Get the feed modification date.
getDescription | ( | ) |
Get the feed description.
getEncoding | ( | ) |
Get the feed character encoding.
getFeedLinks | ( | ) |
Get a link to the XML feed.
getGenerator | ( | ) |
Get the feed generator entry.
getHubs | ( | ) |
Get the URLs used as Pubsubhubbub hubs endpoints.
getId | ( | ) |
Get the feed ID.
getImage | ( | ) |
Get the feed image URI.
getLanguage | ( | ) |
Get the feed language.
getLastBuildDate | ( | ) |
Get the feed last-build date.
getLink | ( | ) |
Get a link to the HTML source.
getTitle | ( | ) |
Get the feed title.
getType | ( | ) |
Retrieve the current or last feed type exported.
remove | ( | $name | ) |
reset | ( | ) |
Resets the instance and deletes all data.
setBaseUrl | ( | $url | ) |
Set the feed's base URL.
string | $url |
Exception\InvalidArgumentException |
setCopyright | ( | $copyright | ) |
Set the copyright entry.
string | $copyright |
Exception\InvalidArgumentException |
setDateCreated | ( | $date = null | ) |
Set the feed creation date.
null|int|DateTime |
Exception\InvalidArgumentException |
setDateModified | ( | $date = null | ) |
Set the feed modification date.
null|int|DateTime |
Exception\InvalidArgumentException |
setDescription | ( | $description | ) |
Set the feed description.
string | $description |
Exception\InvalidArgumentException |
setEncoding | ( | $encoding | ) |
Set the feed character encoding.
string | $encoding |
Exception\InvalidArgumentException |
setFeedLink | ( | $link, | |
$type | |||
) |
Set a link to an XML feed for any feed type/version.
string | $link | |
string | $type |
Exception\InvalidArgumentException |
setGenerator | ( | $name, | |
$version = null , |
|||
$uri = null |
|||
) |
Set the feed generator entry.
array | string | $name | |
null | string | $version | |
null | string | $uri |
Exception\InvalidArgumentException |
setId | ( | $id | ) |
Set the feed ID - URI or URN (via PCRE pattern) supported.
string | $id |
Exception\InvalidArgumentException |
setImage | ( | array | $data | ) |
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.
array | $data |
Exception\InvalidArgumentException |
setLanguage | ( | $language | ) |
Set the feed language.
string | $language |
Exception\InvalidArgumentException |
setLastBuildDate | ( | $date = null | ) |
Set the feed last-build date.
Ignored for Atom 1.0.
null|int|DateTime |
Exception\InvalidArgumentException |
setLink | ( | $link | ) |
Set a link to the HTML source.
string | $link |
Exception\InvalidArgumentException |
setTitle | ( | $title | ) |
Set the feed title.
string | $title |
Exception\InvalidArgumentException |
setType | ( | $type | ) |
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.
string | $type |
|
protected |
|
protected |
|
protected |