kernel/classes/ezrole.php
Classes
File containing the eZRole class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- kernel
- Version
- 4.6.0
\eZRole
Package: kernel
File containing the eZRole class.
- Parent(s)
- \eZPersistentObject
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Version
- 4.6.0
Properties
$AccessArray= ''
Details
- Type
- n/a
$CachePolicies= 'true'
Default value
trueDetails- Type
- n/a
$Functions= ''
Details
- Type
- n/a
$ID= ''
Details
- Type
- n/a
$LimitIdentifier= ''
Details
- Type
- n/a
$LimitValue= ''
Details
- Type
- n/a
$Modules= ''
Details
- Type
- n/a
$Name= ''
Details
- Type
- n/a
$PersistentDataDirty= ''
inheritedInherited from:
\eZPersistentObject::$$PersistentDataDirty
Details
- Type
- n/a
- Inherited_from
- \eZPersistentObject::$$PersistentDataDirty
$Policies= ''
Details
- Type
- n/a
$PolicyArray= ''
Details
- Type
- n/a
$Sets= ''
Details
- Type
- n/a
$UserRoleID= ''
Details
- Type
- n/a
Methods
accessArray(
$ignoreLimitIdentifier
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $ignoreLimitIdentifier |
accessArrayByUserID(
array $idArray, bool $recursive
=
false
)
:
array
static
Return access array by passing in list of groups user belongs to and his user id
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $idArray | array | Array of eZContentObject IDs, either groups + user id or user id's only If only user id's, then remember to set $recursive to true |
| $recursive | bool | See {@link eZRole::fetchByUser()} |
| Type | Description |
|---|---|
| array | Hash with complete access limitation description |
appendPolicy(
$module, $function, $limitations
=
array()
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $module | ||
| $function | ||
| $limitations |
assignToUser(
$userID, $limitIdent
=
'', $limitValue
=
''
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $userID | ||
| $limitIdent | ||
| $limitValue |
attribute(
$attr, $noFunction
=
false
)
:
void
inherited
Inherited from:
\eZPersistentObject::attribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr | ||
| $noFunction |
cleanupByNode(
$node
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $node |
conditionText(
$conditions
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions |
conditionTextByRow(
$conditions, $row
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions | ||
| $row |
copy(
)
:
voidcopyPolicies(
$roleID
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $roleID |
count(
$def, $conds
=
null, $field
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conds | ||
| $field |
create(
$roleName, $version
=
0
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $roleName | ||
| $version |
createNew(
)
:
void
static
createTemporaryVersion(
)
:
voiddefinition(
)
:
void
static
eZPersistentObject(
$row
)
:
void
inherited
Inherited from:
\eZPersistentObject::eZPersistentObject()
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
eZRole(
$row
=
array()
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
escapeArray(
$array
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $array |
expireCache(
)
:
void
static
fetch(
$roleID, $version
=
0
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $roleID | ||
| $version |
fetchByName(
$roleName, $version
=
0
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $roleName | ||
| $version |
fetchByOffset(
$offset, $limit, $asObject
=
true, $ignoreTemp
=
false, $ignoreNew
=
true
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $offset | ||
| $limit | ||
| $asObject | ||
| $ignoreTemp | ||
| $ignoreNew |
fetchByUser(
array $idArray, bool $recursive
=
false
)
:
\array(eZRole)
static
Returns the roles matching the given users' eZContentObject ID array
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $idArray | array | Array of eZContentObject IDs, either groups + user id or user id's only If only user id's, then remember to set $recursive to true |
| $recursive | bool | If true, roles will be looked up for all nodes of the id's and it's parents |
| Type | Description |
|---|---|
| \array(eZRole) |
fetchIDListByUser(
\array(eZContentObjectID) $idArray
)
:
\array(eZRoleID)
static
Fetches the list of roles ID matching an array of eZContentObject IDs (either users and/or groups IDs)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $idArray | \array(eZContentObjectID) |
| Type | Description |
|---|---|
| \array(eZRoleID) |
fetchList(
$tempVersions
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $tempVersions |
fetchObject(
$def, $field_filters, $conds, $asObject
=
true, $grouping
=
null, $custom_fields
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $field_filters | ||
| $conds | ||
| $asObject | ||
| $grouping | ||
| $custom_fields |
fetchObjectList(
$def, $field_filters
=
null, $conds
=
null, $sorts
=
null, $limit
=
null, $asObject
=
true, $grouping
=
false, $custom_fields
=
null, $custom_tables
=
null, $custom_conds
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $field_filters | ||
| $conds | ||
| $sorts | ||
| $limit | ||
| $asObject | ||
| $grouping | ||
| $custom_fields | ||
| $custom_tables | ||
| $custom_conds |
fetchRolesByLimitation(
$limit_identifier, $limit_value
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $limit_identifier | ||
| $limit_value |
fetchUserByRole(
)
:
voidfetchUserID(
)
:
voidfill(
$row
)
:
void
inherited
Inherited from:
\eZPersistentObject::fill()
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
getShortAttributeName(
$db, $def, $attrName
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $db | ||
| $def | ||
| $attrName |
handleRows(
$rows, $class_name, $asObject
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $rows | ||
| $class_name | ||
| $asObject |
hasAttribute(
$attr
)
:
void
inherited
Inherited from:
\eZPersistentObject::hasAttribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr |
limitIdentifier(
)
:
voidlimitValue(
)
:
voidnewObjectOrder(
$def, $orderField, $conditions
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $orderField | ||
| $conditions |
policyList(
)
:
voidremove(
$conditions
=
null, $extraConditions
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::remove()
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions | ||
| $extraConditions |
removeObject(
$def, $conditions
=
null, $extraConditions
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conditions | ||
| $extraConditions |
removePolicies(
$fromDB
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $fromDB |
removePolicy(
$moduleName, $functionName
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $moduleName | ||
| $functionName |
removeRole(
$roleID
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $roleID |
removeTemporary(
)
:
void
static
removeThis(
)
:
voidremoveUserAssignment(
$userID
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $userID |
removeUserAssignmentByID(
$id
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $id |
reorderObject(
$def, $orderField, $conditions, $down
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $orderField | ||
| $conditions | ||
| $down |
replaceFieldsWithShortNames(
$db, $fieldDefs, $fields
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $db | ||
| $fieldDefs | ||
| $fields |
revertFromTemporaryVersion(
)
:
voidroleCount(
boolean $ignoreNew
=
true
)
:
int
static
Fetches the count of created roles
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $ignoreNew | boolean | Wether to ignore draft roles |
| Type | Description |
|---|---|
| int |
- Static
setAttribute(
$attr, $val
)
:
void
inherited
Inherited from:
\eZPersistentObject::setAttribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr | ||
| $val |
setHasDirtyData(
$hasDirtyData
)
:
void
inherited
Inherited from:
\eZPersistentObject::setHasDirtyData()
Parameters
| Name | Type | Description |
|---|---|---|
| $hasDirtyData |
store(
$fieldFilters
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::store()
Parameters
| Name | Type | Description |
|---|---|---|
| $fieldFilters |
storeObject(
$obj, $fieldFilters
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $obj | ||
| $fieldFilters |
swapRow(
$table, $keys, $order_id, $rows, $id1, $id2
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $table | ||
| $keys | ||
| $order_id | ||
| $rows | ||
| $id1 | ||
| $id2 |
sync(
$fieldFilters
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::sync()
Parameters
| Name | Type | Description |
|---|---|---|
| $fieldFilters |
turnOffCaching(
)
:
voidturnOnCaching(
)
:
voidupdateObjectList(
$parameters
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $parameters |
userRoleID(
)
:
void