eZPublish  4.4
eZRSSExport Class Reference

Handles RSS Export in eZ Publish. More...

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

Public Member Functions

 eZRSSExport ($row)
 
 fetchItems ($id=false, $status=eZRSSExport::STATUS_VALID)
 
 fetchRSS1_0 ()
 Get a RSS xml document based on the RSS 1.0 standard based on the RSS Export settings defined by this object. More...
 
 fetchRSS2_0 ()
 Get a RSS xml document based on the RSS 2.0 standard based on the RSS Export settings defined by this object. More...
 
 generateFeed ($type)
 Generates an RSS feed document with type $type and returns it as a string. More...
 
 getObjectListFilter ()
 
 imageNode ()
 
 imagePath ()
 
 itemList ()
 
 modifier ()
 
 removeThis ()
 
 rssXml ()
 Generates an RSS feed document based on the rss_version attribute. More...
 
 rssXmlContent ()
 Generates an RSS feed document based on the rss_version attribute. More...
 
 store ($storeAsValid=false)
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static create ($user_id)
 
static definition ()
 
static fetch ($id, $asObject=true, $status=eZRSSExport::STATUS_VALID)
 
static fetchByName ($access_url, $asObject=true)
 
static fetchList ($asObject=true)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Public Attributes

const STATUS_DRAFT = 0
 
const STATUS_VALID = 1
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

Private Member Functions

 fetchImageURL ()
 
 urlEncodePath ($url)
 

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

static eZRSSExport::create (   $user_id)
static

Creates a new RSS Export

Parameters
UserID
Returns
the URL alias object

Referenced by eZContentOperationCollection\createFeedForNode(), and eZSiteInstaller\setRSSExport().

eZRSSExport::eZRSSExport (   $row)

Initializes a new RSSExport.

Referenced by create().

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

Fetches the RSS Export by ID.

Parameters
RSSExport ID

Referenced by eZRSSEditFunction\storeRSSExport().

static 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(), fetchRSS2_0(), and generateFeed().

eZRSSExport::fetchItems (   $id = false,
  $status = eZRSSExport::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 removeThis().

static eZRSSExport::fetchList (   $asObject = true)
static

Fetches complete list of RSS Exports.

eZRSSExport::fetchRSS1_0 ( )

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

Deprecated:
Returns
DomDocument RSS 1.0 XML document

Referenced by rssXml().

eZRSSExport::fetchRSS2_0 ( )

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

Deprecated:
Returns
string RSS 2.0 XML document

Referenced by rssXml().

eZRSSExport::generateFeed (   $type)

Generates an RSS feed document with type $type and returns it as a string.

It uses the Feed component from eZ Components.

Supported types: 'rss1', 'rss2', 'atom'.

Parameters
string$typeOne of 'rss1', 'rss2' and 'atom'
Returns
string XML document as a string

Referenced by rssXmlContent().

eZRSSExport::getObjectListFilter ( )
eZRSSExport::imageNode ( )
eZRSSExport::imagePath ( )
eZRSSExport::itemList ( )
eZRSSExport::modifier ( )
eZRSSExport::removeThis ( )

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 ( )

Generates an RSS feed document based on the rss_version attribute.

Deprecated:
Returns
DomDocument XML document
eZRSSExport::rssXmlContent ( )

Generates an RSS feed document based on the rss_version attribute.

It uses the Feed component from eZ Components.

Supported types: 'rss1', 'rss2', 'atom'.

Returns
string XML document as a string
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.
eZRSSExport::urlEncodePath (   $url)
private

Performs rawurlencode() on the path part of the URL. The rest is not touched.

Returns
partially encoded url

Referenced by fetchRSS1_0(), fetchRSS2_0(), and generateFeed().

Member Data Documentation

const eZRSSExport::STATUS_DRAFT = 0

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