eZPublish  4.7
eZInformationCollection Class Reference

The class eZInformationCollection handles information collected by content objects. More...

+ Inheritance diagram for eZInformationCollection:
+ Collaboration diagram for eZInformationCollection:

Public Member Functions

 creator ()
 
 dataMap ()
 
 eZInformationCollection ($row)
 
 informationCollectionAttributes ($asObject=true)
 
 object ()
 
- 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 allowAnonymous ($contentObject)
 
static attributeHideList ()
 
static cleanup ()
 
static create ($contentObjectID, $userIdentifier, $creatorID=false)
 
static currentUserIdentifier ()
 
static definition ()
 
static displayHandling ($contentObject)
 
static fetch ($id, $asObject=true)
 
static fetchByUserIdentifier ($userIdentifier, $contentObjectID=false, $asObject=true)
 
static fetchCollectionCountForObject ($objectID)
 
static fetchCollectionsCount ($contentObjectID=false, $creatorID=false, $userIdentifier=false)
 
static fetchCollectionsList ($contentObjectID=false, $creatorID=false, $userIdentifier=false, $limitArray=false, $sortArray=false, $asObject=true)
 
static fetchCountForAttribute ($objectAttributeID, $value)
 
static fetchCountList ($objectAttributeID)
 
static generateUserIdentifier (&$user)
 
static getSortArrayFromParam ($definition, $sortArray)
 
static redirectURL ($contentObject)
 
static removeCollection ($collectionID)
 
static removeContentObject ($delID)
 
static sendOutEmail ($contentObject)
 
static templateForObject ($object)
 
static typeForObject ($object)
 
static userDataHandling ($contentObject)
 
- 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...
 

Additional Inherited Members

- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Detailed Description

The class eZInformationCollection handles information collected by content objects.

Content objects can contain attributes which are able to collect information. The information collected is handled by the eZInformationCollection class.

Member Function Documentation

static eZInformationCollection::allowAnonymous (   $contentObject)
static
Returns
true if anonymous users can submit data to the information collection $contentObject.
static eZInformationCollection::attributeHideList ( )
static
Returns
an array with attribute identifiers that are not to be shown in information collection templates.
static eZInformationCollection::cleanup ( )
static

Removes all collected information.

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.
static eZInformationCollection::create (   $contentObjectID,
  $userIdentifier,
  $creatorID = false 
)
static

Creates a new eZInformationCollection instance.

eZInformationCollection::creator ( )
static eZInformationCollection::currentUserIdentifier ( )
static

Same as generateUserIdentifier but returns the user identifier for the current user.

Referenced by eZInfocollectorFunctionCollection\fetchCollectedInfoCollection().

eZInformationCollection::dataMap ( )
Returns
an array of attributes of the information collection by identifier.

Fetches information collection attributes and indexes by the content class attribute identifier.

static eZInformationCollection::definition ( )
static
Returns
the persistent object definition for the eZInformationCollection class.

Referenced by fetch(), fetchByUserIdentifier(), fetchCollectionsCount(), and fetchCollectionsList().

static eZInformationCollection::displayHandling (   $contentObject)
static
eZInformationCollection::eZInformationCollection (   $row)

Referenced by create().

static eZInformationCollection::fetch (   $id,
  $asObject = true 
)
static

Fetches the information collection by ID.

Referenced by eZInfocollectorFunctionCollection\fetchCollectedInfoCollection().

static eZInformationCollection::fetchByUserIdentifier (   $userIdentifier,
  $contentObjectID = false,
  $asObject = true 
)
static

Fetches the information collection by user identifier.

Referenced by eZInfocollectorFunctionCollection\fetchCollectedInfoCollection().

static eZInformationCollection::fetchCollectionCountForObject (   $objectID)
static
static eZInformationCollection::fetchCollectionsCount (   $contentObjectID = false,
  $creatorID = false,
  $userIdentifier = false 
)
static
Parameters
$creatorID- optional, default false, the user to fetch collections for
$contentObjectID- optional, default false, limits the fetched set of collection to a specific content object

Fetch the number of items limited by the parameters

Referenced by eZInfocollectorFunctionCollection\fetchCollectedInfoCount().

static eZInformationCollection::fetchCollectionsList (   $contentObjectID = false,
  $creatorID = false,
  $userIdentifier = false,
  $limitArray = false,
  $sortArray = false,
  $asObject = true 
)
static
Parameters
$creatorID- optional, default false, limits the fetched set to a creator_id
$contentObjectID- optional, default false, limits the fetched set of collection to a specific content object
$userIdentifier- optional, default false, limits the fetched set to a user_identifier
$limitArray- optional, default false, limits the number of returned results on the form: array( 'limit' => $limit, 'offset' => $offset )
$sortArray- optional, default false, how to sort the result, on the form: array( 'field', true/false ), true = asc
$asObject- optional, default true, specifies if results should be returned as objects.

Fetches a list of information collections.

Referenced by eZInfocollectorFunctionCollection\fetchCollectionsList().

static eZInformationCollection::fetchCountForAttribute (   $objectAttributeID,
  $value 
)
static
static eZInformationCollection::fetchCountList (   $objectAttributeID)
static
static eZInformationCollection::generateUserIdentifier ( $user)
static

Generates a user identifier for the user $user. If $user is null then the current user will be used.

The user identifier is either calculated from the unique user ID or the IP address when the user is anonymous.

Referenced by currentUserIdentifier().

static eZInformationCollection::getSortArrayFromParam (   $definition,
  $sortArray 
)
static
Parameters
$definition- required, definition of fields
$sortArray- required, the input array

This function converts sorting on the form array ( 'field', true ) to the array( 'field' => true ) and checks if the field exists in the definition. The functions is used to make sorting the same way as done in fetch('content','list', ... )

Referenced by fetchCollectionsList().

eZInformationCollection::informationCollectionAttributes (   $asObject = true)

Referenced by dataMap().

eZInformationCollection::object ( )
static eZInformationCollection::redirectURL (   $contentObject)
static
static eZInformationCollection::removeCollection (   $collectionID)
static

Remove a specific collection

Parameters
contentobjectid
static eZInformationCollection::removeContentObject (   $delID)
static

Remove infomation collection from specified contentobject_id

Parameters
delIDcontentobject id
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.

Referenced by eZContentObject\purge().

static eZInformationCollection::sendOutEmail (   $contentObject)
static
static eZInformationCollection::templateForObject (   $object)
static
Returns
the name of the template to use for viewing a specific information collection.

The template name is determined from the content class type and object attributes. See settings/collect.ini for more information.

static eZInformationCollection::typeForObject (   $object)
static
Returns
the name of the template to use for viewing a specific information collection.

The template name is determined from the content class type and object attributes. See settings/collect.ini for more information.

Referenced by allowAnonymous(), displayHandling(), redirectURL(), sendOutEmail(), templateForObject(), and userDataHandling().

static eZInformationCollection::userDataHandling (   $contentObject)
static
Returns
the type of handling that should be performed on user-data.

Possible return types are:

  • multiple
  • unique
  • overwrite

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