eZPublish  3.8
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)
 
 createNew ($roleID, $params=array())
 
 definition ()
 
 eZPolicy ($row)
 
 fetch ($policyID)
 
limitationList ($useCache=true, $ignoreLimitIdentifier=false)
 
limitIdentifier ()
 
limitValue ()
 
 remove ($id=false)
 
role ()
 
 setAttribute ($attr, $val)
 
userRoleID ()
 
- 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

 create ($roleID, $module, $function)
 

Public Attributes

 $Disabled = false
 
 $LimitIdentifier
 
 $LimitValue
 
 $UserRoleID
 

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

Referenced by fetch().

eZPolicy::eZPolicy (   $row)

Constructor

Referenced by create(), and createNew().

eZPolicy::fetch (   $policyID)
& eZPolicy::limitationList (   $useCache = true,
  $ignoreLimitIdentifier = false 
)

Fetch limitation array()

Parameters
uselimitation cache, true by default.

Referenced by accessArray().

& eZPolicy::limitIdentifier ( )
& eZPolicy::limitValue ( )
eZPolicy::remove (   $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::setAttribute (   $attr,
  $val 
)
& 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: