eZPolicyLimitationValue Class Reference

Defines a limitation value for a policy in the permission system. More...

Inheritance diagram for eZPolicyLimitationValue:

Collaboration diagram for eZPolicyLimitationValue:

List of all members.

Public Member Functions
	copy ($limitationID)
	eZPolicyLimitationValue ($row)
Static Public Member Functions
static	create ($limitationID, $value)
static	createNew ($limitationID, $value)
static	definition ()
static	fetchList ($limitationID, $asObject=true)
static	removeByValue ($value, $policyID=false)

---

Detailed Description

Defines a limitation value for a policy in the permission system.

Definition at line 40 of file ezpolicylimitationvalue.php.

---

Member Function Documentation

eZPolicyLimitationValue::copy

(

$

limitationID

)

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 108 of file ezpolicylimitationvalue.php.

static eZPolicyLimitationValue::create	(	$	limitationID,
		$	value
	)		[static]

Creates a new limitation value for the limitation $limitationID and returns it.

Note:

The value is not stored.

Definition at line 96 of file ezpolicylimitationvalue.php.

static eZPolicyLimitationValue::createNew	(	$	limitationID,
		$	value
	)		[static]

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 81 of file ezpolicylimitationvalue.php.

Referenced by copy().

static eZPolicyLimitationValue::definition

(

)

[static]

Returns:

the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

• fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
• keys - an array of fields which is used for uniquely identifying the object in the table.
• function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
• set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
• increment_key - the field which is incremented on table inserts.
• class_name - the classname which is used for instantiating new objecs when fetching from the database.
• sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
• name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 51 of file ezpolicylimitationvalue.php.

Referenced by fetchList(), removeByValue(), and eZPolicyLimitation\valueList().

eZPolicyLimitationValue::eZPolicyLimitationValue

(

$

row

)

Constructor

Definition at line 45 of file ezpolicylimitationvalue.php.

Referenced by create(), and createNew().

static eZPolicyLimitationValue::fetchList	(	$	limitationID,
		$	asObject = true
	)		[static]

Definition at line 113 of file ezpolicylimitationvalue.php.

static eZPolicyLimitationValue::removeByValue	(	$	value,
		$	policyID = false
	)		[static]

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 127 of file ezpolicylimitationvalue.php.

---

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

• ezpolicylimitationvalue.php