eZ Publish  [4.2]
eZRSSExportItem Class Reference

Handles RSS Export Item in eZ Publish. More...

+ Inheritance diagram for eZRSSExportItem:
+ Collaboration diagram for eZRSSExportItem:

List of all members.

Public Member Functions

classAttributes ()
 eZRSSExportItem ($row)
sourceNode ()
sourcePath ()

Static Public Member Functions

static create ($rssexport_id)
static definition ()
static fetch ($id, $asObject=true, $status=eZRSSExport::STATUS_VALID)
static fetchFilteredList ($cond, $asObject=true, $status=eZRSSExport::STATUS_VALID)
static fetchNodeList ($rssSources, $objectListFilter)
static getAttributeMappings ($rssSources)

Detailed Description

Handles RSS Export Item in eZ Publish.

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

Definition at line 41 of file ezrssexportitem.php.


Member Function Documentation

& eZRSSExportItem::classAttributes ( )

Definition at line 129 of file ezrssexportitem.php.

static eZRSSExportItem::create ( rssexport_id) [static]

Creates a new RSS Export Item

Parameters:
eZRSSExportobjcted id. (The RSSExport this item belongs to)
Returns:
the URL alias object

Definition at line 115 of file ezrssexportitem.php.

Referenced by eZSiteInstaller\setRSSExport().

static eZRSSExportItem::definition ( ) [static]
Returns:
the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

  • fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
  • keys - an array of fields which is used for uniquely identifying the object in the table.
  • function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
  • set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
  • increment_key - the field which is incremented on table inserts.
  • class_name - the classname which is used for instantiating new objecs when fetching from the database.
  • sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
  • name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 52 of file ezrssexportitem.php.

Referenced by fetch(), and fetchFilteredList().

eZRSSExportItem::eZRSSExportItem ( row)

Initializes a new RSSExportItem.

Definition at line 47 of file ezrssexportitem.php.

Referenced by create().

static eZRSSExportItem::fetch ( id,
asObject = true,
status = eZRSSExport::STATUS_VALID 
) [static]

Fetches the RSS Export by ID.

Parameters:
RSSExport ID

Definition at line 191 of file ezrssexportitem.php.

Referenced by classAttributes(), getAttributeMappings(), sourceNode(), and sourcePath().

static eZRSSExportItem::fetchFilteredList ( cond,
asObject = true,
status = eZRSSExport::STATUS_VALID 
) [static]
static eZRSSExportItem::fetchNodeList ( rssSources,
objectListFilter 
) [static]

Get the N last published nodes matching the specifications of this RSS Export item

Parameters:
numberof objects to fetch
Returns:
list of Nodes

Definition at line 249 of file ezrssexportitem.php.

Referenced by eZRSSExport\fetchRSS1_0(), and eZRSSExport\fetchRSS2_0().

static eZRSSExportItem::getAttributeMappings ( rssSources) [static]

Definition at line 216 of file ezrssexportitem.php.

Referenced by eZRSSExport\fetchRSS1_0(), and eZRSSExport\fetchRSS2_0().

& eZRSSExportItem::sourceNode ( )

Definition at line 174 of file ezrssexportitem.php.

& eZRSSExportItem::sourcePath ( )

Definition at line 144 of file ezrssexportitem.php.


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