category |
Zend |
package |
Zend_Feed_Writer |
copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license |
New BSD License |
inherited_from |
\Zend_Feed_Writer_Feed_FeedAbstract |
Methods
Method overloading: call given method on first extension implementing it
__call(string $method, array $args) : mixed
Inherited
Parameters
$method
string
$args
array
Exceptions
\Zend_Feed_Exception |
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() : void
Inherited
Set a single author
addAuthor($name, $email = null
, $uri = null
) : string | null
Inherited
Parameters
$name
$email
$uri
Returns
string
null
Set an array with feed authors
addAuthors(array $authors) : array
Inherited
Parameters
$authors
Returns
array
Set an array of feed categories
addCategories(array $categories)
Inherited
Parameters
$categories
array
Add a feed category
addCategory(string $category)
Inherited
Parameters
$category
string
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)
Parameters
$entry
\Zend_Feed_Writer_Entry
Add a Pubsubhubbub hub endpoint URL
addHub(string $url)
Inherited
Add Pubsubhubbub hub endpoint URLs
addHubs(array $urls)
Inherited
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)
Get the number of feed entries.
count() : integer
Required by the Iterator interface.
Returns
integer
Creates a new Zend_Feed_Writer_Entry data container for use. 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.
createEntry() : \Zend_Feed_Writer_Entry
Returns
\Zend_Feed_Writer_Entry
Creates a new Zend_Feed_Writer_Deleted data container for use. 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.
createTombstone() : \Zend_Feed_Writer_Deleted
Returns
\Zend_Feed_Writer_Deleted
Return the current entry
current() : \Zend_Feed_Reader_Entry_Interface
Returns
\Zend_Feed_Reader_Entry_Interface
Attempt to build and return the feed resulting from the data set
export(string $type, boolean $ignoreExceptions = false
) : string
Parameters
$type
string
The feed type "rss" or "atom" to export as
$ignoreExceptions
boolean
Returns
string
Get a single author
getAuthor(integer $index = 0
) : string | null
Inherited
Parameters
$index
integer
Returns
string
null
Get an array with feed authors
getAuthors() : array
Inherited
Get the feed's base url
getBaseUrl() : string | null
Inherited
Get the feed categories
getCategories() : string | null
Inherited
Get the copyright entry
getCopyright() : string | null
Inherited
Get the feed creation date
getDateCreated() : string | null
Inherited
Get the feed modification date
getDateModified() : string | null
Inherited
Get the feed description
getDescription() : string | null
Inherited
Get the feed character encoding
getEncoding() : string | null
Inherited
Retrieve a specific indexed entry from the internal queue. Entries must be
added to a feed container in order to be indexed.
getEntry(integer $index = 0
)
Parameters
$index
integer
Get a link to the XML feed
getFeedLinks() : string | null
Inherited
Get the feed generator entry
getGenerator() : string | null
Inherited
Get the URLs used as Pubsubhubbub hubs endpoints
getHubs() : string | null
Inherited
Get the feed icon URI
getIcon() : array
Inherited
Get the feed ID
getId() : string | null
Inherited
Get the feed image URI
getImage() : array
Inherited
Get the feed language
getLanguage() : string | null
Inherited
Get the feed last-build date
getLastBuildDate() : string | null
Inherited
Get a link to the HTML source
getLink() : string | null
Inherited
Get the feed title
getTitle() : string | null
Inherited
Retrieve the current or last feed type exported.
getType() : string
Inherited
Returns
string
Value will be "rss" or "atom"
Return the current feed key
key() : \unknown
Move the feed pointer forward
next() : void
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() : void
Using this method will alter the original indexation.
Unset a specific data point
remove(string $name)
Inherited
Removes a specific indexed entry from the internal queue. Entries must be
added to a feed container in order to be indexed.
removeEntry(integer $index)
Parameters
$index
integer
Resets the instance and deletes all data
reset() : void
Inherited
Reset the pointer in the feed object
rewind() : void
Set the feed's base URL
setBaseUrl(string $url)
Inherited
Set the copyright entry
setCopyright($copyright) : string | null
Inherited
Parameters
$copyright
Returns
string
null
Set the feed creation date
setDateCreated($date = null
)
Inherited
Set the feed modification date
setDateModified($date = null
)
Inherited
Set the feed description
setDescription($description) : string | null
Inherited
Parameters
$description
Returns
string
null
Set the feed character encoding
setEncoding(string $encoding)
Inherited
Parameters
$encoding
string
Set a link to an XML feed for any feed type/version
setFeedLink($link, $type) : string | null
Inherited
Parameters
$link
$type
Returns
string
null
Set the feed generator entry
setGenerator($name, $version = null
, $uri = null
) : string | null
Inherited
Parameters
$name
$version
$uri
Returns
string
null
Set a feed icon (URI at minimum). Parameter is a single array with the
required key 'uri'. Only 'uri' is required and used for Atom rendering.
setIcon(array $data)
Inherited
RSS does not support an Icon tag except via Atom 1.0 as an extension.
Parameters
$data
array
Set the feed ID - URI or URN (via PCRE pattern) supported
setId(string $id)
Inherited
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)
Inherited
Set the feed language
setLanguage($language) : string | null
Inherited
Parameters
$language
Returns
string
null
Set the feed last-build date. Ignored for Atom 1.0.
setLastBuildDate($date = null
)
Inherited
Set a link to the HTML source
setLink(string $link)
Inherited
Set the feed title
setTitle($title) : string | null
Inherited
Parameters
$title
Returns
string
null
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)
Inherited
Check to see if the iterator is still valid
valid() : boolean
Load extensions from Zend_Feed_Writer
_loadExtensions() : void
Inherited
Validate a URI using the tag scheme (RFC 4151)
_validateTagUri(string $id) : boolean
Inherited
Parameters
$id
string
Returns
boolean
Properties
Contains all Feed level date to append in feed output
$_data : array
Contains all entry objects
$_entries : array
A pointer for the iterator to keep track of the entries array
$_entriesKey : integer
Holds the value "atom" or "rss" depending on the feed type set when
when last exported.
$_type : string