eZPublishCommunityProject(LegacyStack)  2013.5
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)
 
 generateFeed ($type)
 Generates an RSS feed document with type $type and returns it as a string. More...
 
 getObjectListFilter ()
 
 imageNode ()
 
 imagePath ()
 
 itemList ()
 
 modifier ()
 
 removeThis ()
 
 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)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

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)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

const STATUS_DRAFT = 0
 
const STATUS_VALID = 1
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

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 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::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'.

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

Referenced by rssXmlContent().

eZRSSExport::getObjectListFilter ( )

Referenced by generateFeed().

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::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'.

Since
4.2
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 generateFeed().

Member Data Documentation

const eZRSSExport::STATUS_DRAFT = 0

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