eZPublish(LegacyStack)  5.1
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)
 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 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)
 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
 

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: