kernel/classes/ezpolicy.php
Classes
File containing the eZPolicy 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
\eZPolicy
Package: kernel
File containing the eZPolicy 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
$Disabled= 'false'
Default value
falseDetails- Type
- n/a
$LimitIdentifier= ''
Details
- Type
- n/a
$LimitValue= ''
Details
- Type
- n/a
$PersistentDataDirty= ''
inheritedInherited from:
\eZPersistentObject::$$PersistentDataDirty
Details
- Type
- n/a
- Inherited_from
- \eZPersistentObject::$$PersistentDataDirty
$UserRoleID= ''
Details
- Type
- n/a
Methods
accessArray(
$ignoreLimitIdentifier
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $ignoreLimitIdentifier |
appendLimitation(
$identifier, $values
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $identifier | ||
| $values |
attribute(
$attr, $noFunction
=
false
)
:
void
inherited
Inherited from:
\eZPersistentObject::attribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr | ||
| $noFunction |
conditionText(
$conditions
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions |
conditionTextByRow(
$conditions, $row
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions | ||
| $row |
copy(
int $roleID
)
:
\eZPolicyCopies the policy and its limitations to another role
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $roleID | int | the ID of the role to copy to |
| Type | Description |
|---|---|
| \eZPolicy | the created eZPolicy copy |
count(
$def, $conds
=
null, $field
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conds | ||
| $field |
create(
$roleID, $module, $function
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $roleID | ||
| $module | ||
| $function |
createNew(
$roleID, $params
=
array()
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $roleID | ||
| $params |
createTemporaryCopy(
)
:
\eZPolicyCreates a temporary copy for this policy so that it can be edited. The policies will be linked to the copy
Returns
Details
| Type | Description |
|---|---|
| \eZPolicy | the temporary copy |
- Since
- 4.4
definition(
)
:
void
static
eZPersistentObject(
$row
)
:
void
inherited
Inherited from:
\eZPersistentObject::eZPersistentObject()
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
eZPolicy(
$row
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
escapeArray(
$array
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $array |
fetch(
int $policyID
)
:
\eZPolicy
static
Fetches a policy by ID
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $policyID | int | Policy ID |
| Type | Description |
|---|---|
| \eZPolicy |
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 |
fetchTemporaryCopy(
int $policyID
)
:
\eZPolicy
static
Fetches the temporary copy of a policy
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $policyID | int | The original policy ID |
| Type | Description |
|---|---|
| \eZPolicy |
fill(
$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(
)
:
voidlimitationList(
$useCache
=
true, $ignoreLimitIdentifier
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $useCache | ||
| $ignoreLimitIdentifier |
newObjectOrder(
$def, $orderField, $conditions
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $orderField | ||
| $conditions |
remove(
$conditions
=
null, $extraConditions
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::remove()
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions | ||
| $extraConditions |
removeByID(
$id
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $id |
removeObject(
$def, $conditions
=
null, $extraConditions
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conditions | ||
| $extraConditions |
removeThis(
$id
=
false
)
:
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 |
role(
)
:
voidsaveTemporary(
)
:
voidSaves a temporary limitation created with {@link createTemporaryCopy()}
Throws
| Exception | Description |
|---|---|
| \Exception | The policy isn't a temporary one |
setAttribute(
$attr, $val
)
:
void
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 |
updateObjectList(
$parameters
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $parameters |
userRoleID(
)
:
void