eZPublish  4.4
eZRSSImport Class Reference

Handles RSS Import in eZ Publish. More...

+ Inheritance diagram for eZRSSImport:
+ Collaboration diagram for eZRSSImport:

Public Member Functions

 classAttributes ()
 
 destinationPath ()
 
 eZRSSImport ($row)
 
 importDescription ()
 
 modifier ()
 
 objectOwner ()
 
 setImportDescription ($definition=array())
 
 store ($fieldFilters=null)
 
- 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 arrayMergeRecursive ($arr1, $arr2)
 
static create ($userID=false)
 
static definition ()
 
static fetch ($id, $asObject=true, $status=eZRSSImport::STATUS_VALID)
 
static fetchActiveList ($asObject=true)
 
static fetchList ($asObject=true, $status=eZRSSImport::STATUS_VALID)
 
static fieldMap ($version= '2.0')
 
static getRSSVersion ($url)
 
static objectAttributeList ()
 
static recursiveFieldMap ($definitionArray, $globalKey, $value, &$returnArray, $count)
 
static rssFieldDefinition ($version= '2.0')
 
- 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...
 

Detailed Description

Handles RSS Import in eZ Publish.

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

Member Function Documentation

static eZRSSImport::arrayMergeRecursive (   $arr1,
  $arr2 
)
static

Referenced by fieldMap().

eZRSSImport::classAttributes ( )
static eZRSSImport::create (   $userID = false)
static

Creates a new RSS Import

Parameters
UserID
Returns
the new RSS Import object
static eZRSSImport::definition ( )
static

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

eZRSSImport::destinationPath ( )
eZRSSImport::eZRSSImport (   $row)

Initializes a new RSSImport.

Referenced by create().

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

Fetches the RSS Import by ID.

Parameters
RSSImport ID
static eZRSSImport::fetchActiveList (   $asObject = true)
static

Fetches complete list of active RSS Imports.

static eZRSSImport::fetchList (   $asObject = true,
  $status = eZRSSImport::STATUS_VALID 
)
static

Fetches complete list of RSS Imports.

static eZRSSImport::fieldMap (   $version = '2.0')
static
Parameters
RSSversion
Returns
Ordered array of field definitions
static eZRSSImport::getRSSVersion (   $url)
static

Analize RSS import, and get RSS version number

Parameters
URL
Returns
RSS version number, false if invalid URL
eZRSSImport::importDescription ( )

Get import description

Returns
import description
eZRSSImport::modifier ( )
static eZRSSImport::objectAttributeList ( )
static

Object attribute list

eZRSSImport::objectOwner ( )
static eZRSSImport::recursiveFieldMap (   $definitionArray,
  $globalKey,
  $value,
$returnArray,
  $count 
)
static

Recursivly build field map

Parameters
array

Referenced by fieldMap().

static eZRSSImport::rssFieldDefinition (   $version = '2.0')
static

Return default RSS field definition

Parameters
RSSversion
Returns
RSS field definition array.

Referenced by fieldMap().

eZRSSImport::setImportDescription (   $definition = array())

Set import description

Import definition must be set as an multidimentional array.

Example : array( 'rss_version' => <version>, 'object_attributes' => array( ... ), 'class_attributes' => array( <content class="" attribute="" id>=""> => <RSS import="" field>="">, ... ) )

eZRSSImport::store (   $fieldFilters = null)

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.

Member Data Documentation

const eZRSSImport::STATUS_DRAFT = 0

Referenced by storeRSSImport().

const eZRSSImport::STATUS_VALID = 1

Referenced by storeRSSImport().


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