Docs For Class ZEND_EPS_FEED

ZEND_EPS_FEED_WRITER

Description

Located in /lib/class.zend.eps_feed_writer.inc (line 21)

Variable Summary

Object $entry

Object $feed

String $feedLink

String $feedType

Method Summary

ZEND_EPS_FEED_WRITER __construct ([String $feedTitle = NULL], [String $feedLink = NULL], [String $feedType = 'atom'])

String exec ([Boolean $hideError = true])

String formatRSSLink ()

String formatURL (String $url)

boolean getEntry ([String $entryTitle = NULL], [String $entryLink = NULL])

boolean setEntry ()

void setEntryAuthor ([Array $arr = array()])

void setEntryCategory ([Array $arr = array()])

void setEntryContent ([String $val = NULL])

void setEntryCopyright ([String $text = NULL])

void setEntryDescription ([String $val = NULL])

void setEntryId ([String $id = NULL])

void setEntryLink ([String $url = NULL])

void setFeedAuthor ([Array $arr = array()])

void setFeedBaseURL ([String $url = NULL])

void setFeedCopyright ([String $text = NULL])

void setFeedDescription ([String $text = NULL])

void setFeedGenerator ([Array $arr = array()])

void setFeedIcon ([Array $arr = array()])

void setFeedId ([String $id = NULL])

void setFeedLanguage ([String $lang = 'en'])

void setFeedLink ([String $url = NULL])

void setFeedLogo ([Array $arr = array()])

Variables

Object $entry (line 40)

Feed entry object of type Zend_Feed_Writer_Entry

access: protected

Object $feed (line 28)

Feed writer object.

access: protected

String $feedLink (line 48)

Feed link URL that serves as a bridge between the feed Id and link properties.

Included simply to keep linking from breaking and having a fall-back default value.

access: protected

String $feedType (line 34)

The feed type, atom (default) or rss.

access: protected

Methods

Constructor __construct (line 67)

Constructor.

Creates a Zend_Feed_Writer_Feed object. Sets the create date, feed type (rss or atom [default]), the feed title, feed link and id (which can be overridden), and the feed language to English. The feed link and feed id are formed off of the feed link string that is provided here.

throws: Zend_Date_Exception
throws: Zend_Exception
throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::setFeedLink()
uses: ZEND_EPS_FEED_WRITER::formatURL()
uses: ZEND_EPS_FEED_WRITER::setFeedId()
uses: ZEND_EPS_FEED_WRITER::setFeedLanguage()

ZEND_EPS_FEED_WRITER __construct ([String $feedTitle = NULL], [String $feedLink = NULL], [String $feedType = 'atom'])

String $feedTitle
String $feedLink
String $feedType

exec (line 639)

Executes the feed export process and sets the final modified date. Suppresses exception errors by default.

Performs some final housecleaning of the internal _data object by converting it into an XML object and changing what needs to be changed due to the feed type. ZF does not seem to do a good job at regulating the document format for each particular feed, so we must do it here.

throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::formatRSSLink()

String exec ([Boolean $hideError = true])

Boolean $hideError

formatRSSLink (line 674)

Formats the RSS link value to the object feed link.

Doing this since ZF does not provide a link node in the RSS channel.

access: protected
usedby: ZEND_EPS_FEED_WRITER::exec()

String formatRSSLink ()

formatURL (line 662)

Formats the URL to have the proper slash usage.

access: protected
usedby: ZEND_EPS_FEED_WRITER::setFeedBaseURL()
usedby: ZEND_EPS_FEED_WRITER::getEntry()
usedby: ZEND_EPS_FEED_WRITER::setEntryLink()
usedby: ZEND_EPS_FEED_WRITER::setEntryCategory()
usedby: ZEND_EPS_FEED_WRITER::setFeedIcon()
usedby: ZEND_EPS_FEED_WRITER::setFeedLogo()
usedby: ZEND_EPS_FEED_WRITER::__construct()
usedby: ZEND_EPS_FEED_WRITER::setFeedLink()
usedby: ZEND_EPS_FEED_WRITER::setFeedAuthor()
usedby: ZEND_EPS_FEED_WRITER::setFeedGenerator()

String formatURL (String $url)

String $url

getEntry (line 408)

Creates an entry for the feed. Also sets the entry title and link.

The GETTER must be called first to create the entry, set the desired entry information, and then call the SETTER to add the entry to the feed.

throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::setEntryLink()
uses: ZEND_EPS_FEED_WRITER::setEntryId()
uses: ZEND_EPS_FEED_WRITER::formatURL()

boolean getEntry ([String $entryTitle = NULL], [String $entryLink = NULL])

String $entryTitle
String $entryLink

setEntry (line 435)

Sets the entry data to the feed. It also sets the entry create and modified dates.

throws: Zend_Feed_Exception
access: public

boolean setEntry ()

setEntryAuthor (line 495)

Sets the entry author(s) data.

throws: Zend_Feed_Exception
access: public

void setEntryAuthor ([Array $arr = array()])

Array $arr

setEntryCategory (line 594)

Sets the entry category data. Multiple categories may be entered by calling this method repeatedly.

Array key values are label, term, scheme.

throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setEntryCategory ([Array $arr = array()])

Array $arr

setEntryContent (line 476)

Sets the entry content.

throws: Zend_Feed_Exception
access: public

void setEntryContent ([String $val = NULL])

String $val

setEntryCopyright (line 574)

Sets the entry copyright information.

throws: Zend_Feed_Exception
access: public

void setEntryCopyright ([String $text = NULL])

String $text

setEntryDescription (line 457)

Sets the entry description.

throws: Zend_Feed_Exception
access: public

void setEntryDescription ([String $val = NULL])

String $val

setEntryId (line 554)

Sets the entry id. This is usually the same as the entry link and must be a well-formed URI.

During the export process, the class will reformat the id with a more unique value that includes a scheme and obfuscated URL string.

throws: Zend_Feed_Exception
access: public
usedby: ZEND_EPS_FEED_WRITER::getEntry()

void setEntryId ([String $id = NULL])

String $id

setEntryLink (line 533)

Sets the entry link.

throws: Zend_Feed_Exception
access: public
usedby: ZEND_EPS_FEED_WRITER::getEntry()
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setEntryLink ([String $url = NULL])

String $url

setFeedAuthor (line 169)

Sets the feed author(s) data.

Array key values are name, email, uri.

throws: Zend_Exception
throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setFeedAuthor ([Array $arr = array()])

Array $arr

setFeedBaseURL (line 378)

Sets the feed base URL.

Any relative references are resolved using this path.

throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setFeedBaseURL ([String $url = NULL])

String $url

setFeedCopyright (line 271)

Sets the feed copyright information.

throws: Zend_Feed_Exception
access: public

void setFeedCopyright ([String $text = NULL])

String $text

setFeedDescription (line 104)

Sets the feed description text.

throws: Zend_Feed_Exception
access: public

void setFeedDescription ([String $text = NULL])

String $text

setFeedGenerator (line 215)

Sets the feed generator data. Defaults to the Zend Framework version data.

Array key values are name, version, uri.

throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setFeedGenerator ([Array $arr = array()])

Array $arr

setFeedIcon (line 336)

Sets the feed icon image.

Array key values are uri, link, title, description.

throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setFeedIcon ([Array $arr = array()])

Array $arr

setFeedId (line 147)

Sets the feed id.

This is a unique and valid URI value and is normally set automatically off of the base URL or the feed link URL, whichever is set later. If a feed id is needed, always call this method last to ensure that it is set just as you want it.

throws: Zend_Feed_Exception
access: public
usedby: ZEND_EPS_FEED_WRITER::__construct()

void setFeedId ([String $id = NULL])

String $id

setFeedLanguage (line 251)

Sets the feed language.

throws: Zend_Feed_Exception
access: public
usedby: ZEND_EPS_FEED_WRITER::__construct()

void setFeedLanguage ([String $lang = 'en'])

String $lang

setFeedLink (line 124)

Sets the feed link URL. Must be a well-formed URI.

throws: Zend_Feed_Exception
access: public
usedby: ZEND_EPS_FEED_WRITER::__construct()
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setFeedLink ([String $url = NULL])

String $url

setFeedLogo (line 292)

Sets the feed logo image. Height and width properties only apply to RSS feeds.

Array key values are uri, link, title, description, height, width.

throws: Zend_Feed_Exception
access: public
uses: ZEND_EPS_FEED_WRITER::formatURL()

void setFeedLogo ([Array $arr = array()])

Array $arr

Documentation generated on Tue, 05 Jun 2012 05:52:12 -0700 by phpDocumentor 1.4.3