eZPublishCommunityProject(LegacyStack)  2013.6
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)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

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)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

 $Disabled = false
 
 $LimitIdentifier
 
 $LimitValue
 
 $UserRoleID
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

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: