eZPublish  4.5
eZPolicy Class Reference

Defines a policy in the permission system. More...

+ Inheritance diagram for eZPolicy:
+ Collaboration diagram for eZPolicy:

Public Member Functions

 accessArray ($ignoreLimitIdentifier=false)
 
 appendLimitation ($identifier, $values)
 
 copy ($roleID)
 Copies the policy and its limitations to another role. More...
 
 createTemporaryCopy ()
 Creates a temporary copy for this policy so that it can be edited. More...
 
 eZPolicy ($row)
 
 limitationList ($useCache=true, $ignoreLimitIdentifier=false)
 
 limitIdentifier ()
 
 limitValue ()
 
 removeThis ($id=false)
 
 role ()
 
 saveTemporary ()
 Saves a temporary limitation created with createTemporaryCopy(). More...
 
 setAttribute ($attr, $val)
 
 userRoleID ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static create ($roleID, $module, $function)
 
static createNew ($roleID, $params=array())
 
static definition ()
 
static fetch ($policyID)
 Fetches a policy by ID. More...
 
static fetchTemporaryCopy ($policyID)
 Fetches the temporary copy of a policy. More...
 
static removeByID ($id)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
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)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Public Attributes

 $Disabled = false
 
 $LimitIdentifier
 
 $LimitValue
 
 $UserRoleID
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

Detailed Description

Defines a policy in the permission system.

Member Function Documentation

eZPolicy::accessArray (   $ignoreLimitIdentifier = false)

Generate access array from this policy.

return access array

eZPolicy::appendLimitation (   $identifier,
  $values 
)

Appends a new policy limitation to the current policy and returns it.

Note
The limitation and it's values will be stored to the database before returning.
Parameters
$identifierThe identifier for the limitation, e.g. 'Class'
$valuesArray of values to store for limitation.
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.
eZPolicy::copy (   $roleID)

Copies the policy and its limitations to another role.

Parameters
int$roleIDthe ID of the role to copy to
Returns
eZPolicy the created eZPolicy copy
static eZPolicy::create (   $roleID,
  $module,
  $function 
)
static

Creates a new policy assigned to the role identified by ID $roleID and returns it.

Note
The policy is not stored.
Parameters
$moduleWhich module to give access to or true to give access to all modules.
$functionWhich function to give access to or true to give access to all functions.
$limitationsAn associative array with limitations and their values, use an empty array for no limitations.

Referenced by eZRole\appendPolicy().

static eZPolicy::createNew (   $roleID,
  $params = array() 
)
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.

Referenced by copy(), and eZStepCreateSites\initializePackage().

eZPolicy::createTemporaryCopy ( )

Creates a temporary copy for this policy so that it can be edited.

The policies will be linked to the copy

Returns
eZPolicy the temporary copy
Since
4.4
static eZPolicy::definition ( )
static

Referenced by eZRole\policyList().

eZPolicy::eZPolicy (   $row)

Constructor

Referenced by create(), and createNew().

static eZPolicy::fetch (   $policyID)
static

Fetches a policy by ID.

Parameters
int$policyIDPolicy ID
Returns
eZPolicy

Referenced by eZSubtreeNotificationRule\checkObjectAccess(), eZRole\cleanupByNode(), eZPolicyLimitation\policy(), removeByID(), and saveTemporary().

static eZPolicy::fetchTemporaryCopy (   $policyID)
static

Fetches the temporary copy of a policy.

Parameters
int$policyIDThe original policy ID
Returns
eZPolicy
eZPolicy::limitationList (   $useCache = true,
  $ignoreLimitIdentifier = false 
)

Fetch limitation array()

Parameters
uselimitation cache, true by default.

Referenced by accessArray().

eZPolicy::limitIdentifier ( )
eZPolicy::limitValue ( )
static eZPolicy::removeByID (   $id)
static
See Also
removeThis
eZPolicy::removeThis (   $id = false)
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.
eZPolicy::role ( )
eZPolicy::saveTemporary ( )

Saves a temporary limitation created with createTemporaryCopy().

Exceptions
ExceptionThe policy isn't a temporary one
Returns
void
eZPolicy::setAttribute (   $attr,
  $val 
)

Referenced by saveTemporary().

eZPolicy::userRoleID ( )

Member Data Documentation

eZPolicy::$Disabled = false
eZPolicy::$LimitIdentifier

Referenced by limitIdentifier().

eZPolicy::$LimitValue

Referenced by limitValue().

eZPolicy::$UserRoleID

Referenced by accessArray(), and userRoleID().


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