eZPublish  3.9
eZRSSExport Class Reference

Handles RSS Export in eZ publish. More...

+ Inheritance diagram for eZRSSExport:
+ Collaboration diagram for eZRSSExport:

Public Member Functions

 definition ()
 
 eZRSSExport ($row)
 
 fetchItems ($id=false, $status=EZ_RSSEXPORT_STATUS_VALID)
 
 fetchRSS1_0 ($id=null)
 
 fetchRSS2_0 ($id=null)
 
 getObjectListFilter ()
 
imageNode ()
 
imagePath ()
 
itemList ()
 
modifier ()
 
 remove ()
 
rssXml ()
 
 store ($storeAsValid=false)
 
- Public Member Functions inherited from eZPersistentObject
attribute ($attr, $noFunction=false)
 
 attributes ()
 
 conditionText (&$conditions)
 
conditionTextByRow (&$conditions, &$row)
 
 definition ()
 
escapeArray (&$array)
 
 eZPersistentObject ($row)
 
 fetchObject (&$def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
 fetchObjectList (&$def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 
 fill (&$row)
 
 getShortAttributeName (&$db, &$def, $attrName)
 
 handleRows (&$rows, $class_name, $asObject)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 newObjectOrder (&$def, $orderField, $conditions)
 
 remove ($conditions=null, $extraConditions=null)
 
 removeObject (&$def, $conditions=null, $extraConditions=null)
 
 reorderObject (&$def, $orderField, $conditions, $down=true)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 swapRow ($table, &$keys, &$order_id, &$rows, $id1, $id2)
 
 sync ($fieldFilters=null)
 
 updateObjectList ($parameters)
 

Static Public Member Functions

 create ($user_id)
 
 fetch ($id, $asObject=true, $status=EZ_RSSEXPORT_STATUS_VALID)
 
 fetchByName ($access_url, $asObject=true)
 
 fetchList ($asObject=true)
 

Private Member Functions

 fetchImageURL ()
 

Detailed Description

Handles RSS Export in eZ publish.

RSSExport is used to create RSS feeds from published content. See kernel/rss for more files.

Member Function Documentation

eZRSSExport::create (   $user_id)
static

Creates a new RSS Export

Parameters
UserID
Returns
the URL alias object
eZRSSExport::definition ( )

Referenced by fetch(), fetchByName(), and fetchList().

eZRSSExport::eZRSSExport (   $row)

Initializes a new RSSExport.

Referenced by create().

eZRSSExport::fetch (   $id,
  $asObject = true,
  $status = EZ_RSSEXPORT_STATUS_VALID 
)
static

Fetches the RSS Export by ID.

Parameters
RSSExport ID

Referenced by fetchRSS1_0(), fetchRSS2_0(), and eZRSSEditFunction\storeRSSExport().

eZRSSExport::fetchByName (   $access_url,
  $asObject = true 
)
static

Fetches the RSS Export by feed access url and is active.

Parameters
RSSExport access url
eZRSSExport::fetchImageURL ( )
private

Fetch Image from current ezrss export object. If non exist, or invalid, return false

Returns
valid image url

Referenced by fetchRSS1_0(), and fetchRSS2_0().

eZRSSExport::fetchItems (   $id = false,
  $status = EZ_RSSEXPORT_STATUS_VALID 
)

Fetches RSS Items related to this RSS Export. The RSS Export Items contain information about which nodes to export information from

Parameters
RSSExportID (optional). Uses current RSSExport's ID as default
Returns
RSSExportItem list. null if no RSS Export items found

Referenced by itemList(), and remove().

eZRSSExport::fetchList (   $asObject = true)
static

Fetches complete list of RSS Exports.

eZRSSExport::fetchRSS1_0 (   $id = null)

Get a RSS xml document based on the RSS 1.0 standard based on the RSS Export settings defined by this object

Parameters
objectID
Returns
RSS 1.0 XML document

Referenced by rssXml().

eZRSSExport::fetchRSS2_0 (   $id = null)

Get a RSS xml document based on the RSS 2.0 standard based on the RSS Export settings defined by this object

Parameters
\returnRSS 2.0 XML document

Referenced by rssXml().

eZRSSExport::getObjectListFilter ( )

Referenced by fetchRSS1_0(), and fetchRSS2_0().

& eZRSSExport::imageNode ( )
& eZRSSExport::imagePath ( )
& eZRSSExport::itemList ( )
& eZRSSExport::modifier ( )
eZRSSExport::remove ( )

Remove the RSS Export.

Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.
& eZRSSExport::rssXml ( )
eZRSSExport::store (   $storeAsValid = false)

Store Object to database

Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

The documentation for this class was generated from the following file: