eZPublish  3.8
eZRSSImport Class Reference

Handles RSS Import in eZ publish. More...

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

Public Member Functions

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

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

eZRSSImport::arrayMergeRecursive (   $arr1,
  $arr2 
)

Referenced by fieldMap().

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

Creates a new RSS Import

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

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

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

Initializes a new RSSImport.

Referenced by create().

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

Fetches the RSS Import by ID.

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

Fetches complete list of active RSS Imports.

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

Fetches complete list of RSS Imports.

& eZRSSImport::fieldMap (   $version = '2.0')
static
Parameters
RSSversion
Returns
Ordered array of field definitions
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 ( )
& eZRSSImport::objectAttributeList ( )
static

Object attribute list

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

Recursivly build field map

Parameters
array

Referenced by fieldMap().

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

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: