eZInformationCollection Class Reference

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

Inheritance diagram for eZInformationCollection:

Collaboration diagram for eZInformationCollection:

List of all members.

Public Member Functions
	creator ()
	dataMap ()
	eZInformationCollection ($row)
	informationCollectionAttributes ($asObject=true)
	object ()
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)

---

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.

Definition at line 39 of file ezinformationcollection.php.

---

Member Function Documentation

static eZInformationCollection::allowAnonymous

(

$

contentObject

)

[static]

Returns:

true if anonymous users can submit data to the information collection $contentObject.

Definition at line 220 of file ezinformationcollection.php.

static eZInformationCollection::attributeHideList

(

)

[static]

Returns:

an array with attribute identifiers that are not to be shown in information collection templates.

Definition at line 96 of file ezinformationcollection.php.

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.

Definition at line 741 of file ezinformationcollection.php.

static eZInformationCollection::create	(	$	contentObjectID,
		$	userIdentifier,
		$	creatorID = false
	)		[static]

Creates a new eZInformationCollection instance.

Definition at line 718 of file ezinformationcollection.php.

eZInformationCollection::creator

(

)

Definition at line 614 of file ezinformationcollection.php.

static eZInformationCollection::currentUserIdentifier

(

)

[static]

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

Definition at line 682 of file ezinformationcollection.php.

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.

Definition at line 654 of file ezinformationcollection.php.

static eZInformationCollection::definition

(

)

[static]

Returns:

the persistent object definition for the eZInformationCollection class.

Reimplemented from eZPersistentObject.

Definition at line 49 of file ezinformationcollection.php.

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

static eZInformationCollection::displayHandling

(

$

contentObject

)

[static]

Definition at line 336 of file ezinformationcollection.php.

eZInformationCollection::eZInformationCollection

(

$

row

)

Definition at line 41 of file ezinformationcollection.php.

Referenced by create().

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

Fetches the information collection by ID.

Definition at line 409 of file ezinformationcollection.php.

Referenced by creator(), and object().

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

Fetches the information collection by user identifier.

Definition at line 421 of file ezinformationcollection.php.

static eZInformationCollection::fetchCollectionCountForObject

(

$

objectID

)

[static]

Definition at line 452 of file ezinformationcollection.php.

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

Definition at line 571 of file ezinformationcollection.php.

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.

Definition at line 509 of file ezinformationcollection.php.

static eZInformationCollection::fetchCountForAttribute	(	$	objectAttributeID,
		$	value
	)		[static]

Definition at line 432 of file ezinformationcollection.php.

static eZInformationCollection::fetchCountList

(

$

objectAttributeID

)

[static]

Definition at line 593 of file ezinformationcollection.php.

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.

Definition at line 695 of file ezinformationcollection.php.

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', ... )

Definition at line 474 of file ezinformationcollection.php.

Referenced by fetchCollectionsList().

eZInformationCollection::informationCollectionAttributes

(

$

asObject = true

)

Definition at line 620 of file ezinformationcollection.php.

Referenced by dataMap().

eZInformationCollection::object

(

)

Definition at line 674 of file ezinformationcollection.php.

static eZInformationCollection::redirectURL

(

$

contentObject

)

[static]

Definition at line 372 of file ezinformationcollection.php.

static eZInformationCollection::removeCollection

(

$

collectionID

)

[static]

Remove a specific collection

Parameters:

contentobject

id

Definition at line 142 of file ezinformationcollection.php.

static eZInformationCollection::removeContentObject

(

$

delID

)

[static]

Remove infomation collection from specified contentobject_id

Parameters:

delID

contentobject 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.

Definition at line 118 of file ezinformationcollection.php.

Referenced by eZContentObject\purge().

static eZInformationCollection::sendOutEmail

(

$

contentObject

)

[static]

Definition at line 303 of file ezinformationcollection.php.

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.

Definition at line 164 of file ezinformationcollection.php.

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.

Definition at line 176 of file ezinformationcollection.php.

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

Definition at line 267 of file ezinformationcollection.php.

---

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

• ezinformationcollection.php