eZPublish  3.8
eZInformationCollection Class Reference

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

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

Public Member Functions

create ($contentObjectID, $userIdentifier, $creatorID=false)
 
creator ()
 
 currentUserIdentifier ()
 
dataMap ()
 
 definition ()
 
 displayHandling (&$contentObject)
 
 eZInformationCollection ($row)
 
 fetchCollectionCountForObject ($objectID)
 
 fetchCountForAttribute ($objectAttributeID, $value)
 
 fetchCountList ($objectAttributeID)
 
 generateUserIdentifier (&$user)
 
informationCollectionAttributes ($asObject=true)
 
object ()
 
 redirectURL (&$contentObject)
 
 sendOutEmail (&$contentObject)
 
- 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

 allowAnonymous (&$contentObject)
 
 attributeHideList ()
 
 cleanup ()
 
 fetch ($id, $asObject=true)
 
 fetchByUserIdentifier ($userIdentifier, $contentObjectID=false, $asObject=true)
 
 fetchCollectionsCount ($contentObjectID=false, $creatorID=false, $userIdentifier=false)
 
 fetchCollectionsList ($contentObjectID=false, $creatorID=false, $userIdentifier=false, $limitArray=false, $sortArray=false, $asObject=true)
 
 getSortArrayFromParam ($definition, $sortArray)
 
 removeCollection ($collectionID)
 
 removeContentObject ($delID)
 
 templateForObject (&$object)
 
 typeForObject (&$object)
 
 userDataHandling (&$contentObject)
 

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

eZInformationCollection::allowAnonymous ( $contentObject)
static
Returns
true if anonymous users can submit data to the information collection $contentObject.
eZInformationCollection::attributeHideList ( )
static
Returns
an array with attribute identifiers that are not to be shown in information collection templates.
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.
& eZInformationCollection::create (   $contentObjectID,
  $userIdentifier,
  $creatorID = false 
)

Creates a new eZInformationCollection instance.

& eZInformationCollection::creator ( )
eZInformationCollection::currentUserIdentifier ( )

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

Referenced by eZContentFunctionCollection\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.

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

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

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

Referenced by create().

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

Fetches the information collection by ID.

Referenced by eZContentFunctionCollection\fetchCollectedInfoCollection().

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

Fetches the information collection by user identifier.

Referenced by eZContentFunctionCollection\fetchCollectedInfoCollection().

eZInformationCollection::fetchCollectionCountForObject (   $objectID)
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 eZContentFunctionCollection\fetchCollectedInfoCount().

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 eZContentFunctionCollection\fetchCollectionsList().

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

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

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 ( )
eZInformationCollection::redirectURL ( $contentObject)
eZInformationCollection::removeCollection (   $collectionID)
static

Remove a specific collection

Parameters
contentobjectid
eZInformationCollection::removeContentObject (   $delID)
static

Remove infomation collection from specified contentobject_id

Parameters
contentobjectid
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().

eZInformationCollection::sendOutEmail ( $contentObject)
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.

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

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: