AddBlockToAreaAreaKey
class AddBlockToAreaAreaKey extends AreaKey (View source)
Constants
| ACCESS_TYPE_INCLUDE |
Access type: inclusive. |
| ACCESS_TYPE_EXCLUDE |
Access type: exclusive. |
| ACCESS_TYPE_ALL |
Access type: any. |
| OPERATION_NEWBLOCK |
Operation identifier: adding a new block to the area. |
| OPERATION_EXISTINGBLOCK |
Operation identifier: moving an existing block from another area. |
Properties
| $error | from ConcreteObject | ||
| protected ObjectInterface|null | $permissionObject | The object for which this permission is for (for example, a Page instance). |
from Key |
| bool|int|string | $pkID | from Key | |
| string | $pkName | from Key | |
| string | $pkHandle | from Key | |
| string | $pkDescription | from Key | |
| bool|int|string | $pkCategoryID | from Key | |
| string | $pkCategoryHandle | from Key | |
| bool|int|string|null | $pkgID | from Key | |
| bool|int|string | $pkCanTriggerWorkflow | from Key | |
| bool|int|string | $pkHasCustomClass | from Key | |
| ObjectInterface|null | $permissionObjectToCheck | from Key |
Methods
Get the identifiers (keys) and descriptions (values) of the access types.
Returns whether a permission key can start a workflow.
Returns the display name for this permission key (localized and escaped accordingly to $format).
Returns the display description for this permission key (localized and escaped accordingly to $format).
Returns the handle for the category of this permission key.
Set the object for which this permission is for (for example, a Page instance).
Set the actual object that should be checked for this permission (for example, a Page instance).
Get the object for which this permission is for (for example, a Page instance).
Does this permission key have a form (located at elements/permission/keys/
Get the handle of the package that defines this permission key.
Returns the list of all permissions of this category.
Export the list of all permissions of this category to a SimpleXMLElement instance.
Adds an permission key.
Mark this permission key as having (or not) a custom class.
A shortcut for grabbing the current assignment and passing into that object.
Load a permission key by its ID (or whatever is passed to $loadBy).
No description
Get the list of allowed block type IDs for a specific operation.
Details
loadError($error)
No description
isError()
No description
getError()
No description
setPropertiesFromArray($arr)
No description
static
camelcase($file)
No description
static
uncamelcase($string)
No description
in
Key at line 65
array
getSupportedAccessTypes()
Get the identifiers (keys) and descriptions (values) of the access types.
in
Key at line 80
bool
canPermissionKeyTriggerWorkflow()
Returns whether a permission key can start a workflow.
in
Key at line 90
bool
permissionKeyHasCustomClass()
Returns whether a permission key has a custom class.
in
Key at line 100
string
getPermissionKeyName()
Returns the name for this permission key.
in
Key at line 114
string
getPermissionKeyDisplayName(string $format = 'html')
Returns the display name for this permission key (localized and escaped accordingly to $format).
in
Key at line 131
string
getPermissionKeyHandle()
Returns the handle for this permission key.
in
Key at line 141
string
getPermissionKeyDescription()
Returns the description for this permission key.
in
Key at line 155
string
getPermissionKeyDisplayDescription(string $format = 'html')
Returns the display description for this permission key (localized and escaped accordingly to $format).
in
Key at line 172
int
getPermissionKeyID()
Returns the ID for this permission key.
in
Key at line 182
int
getPermissionKeyCategoryID()
Returns the ID for the category of this permission key.
in
Key at line 192
string
getPermissionKeyCategoryHandle()
Returns the handle for the category of this permission key.
in
Key at line 202
setPermissionObject(ObjectInterface|null $object)
Set the object for which this permission is for (for example, a Page instance).
in
Key at line 212
getPermissionObjectToCheck()
Set the actual object that should be checked for this permission (for example, a Page instance).
in
Key at line 226
ObjectInterface|null
getPermissionObject()
Get the object for which this permission is for (for example, a Page instance).
in
Key at line 236
static Key[]
loadAll()
Get the list of all the defined permission keys.
in
Key at line 275
bool
hasCustomOptionsForm()
Does this permission key have a form (located at elements/permission/keys/
in
Key at line 293
int|null
getPackageID()
Get the ID of the package that defines this permission key.
in
Key at line 303
string|null
getPackageHandle()
Get the handle of the package that defines this permission key.
in
Key at line 318
static Key[]
getList(string $pkCategoryHandle, array $filters = [])
Returns the list of all permissions of this category.
in
Key at line 345
SimpleXMLElement
export(SimpleXMLElement $axml)
Export this permission key to a SimpleXMLElement instance.
in
Key at line 364
static
exportList(SimpleXMLElement $xml)
Export the list of all permissions of this category to a SimpleXMLElement instance.
in
Key at line 385
static Key[]
getListByPackage(Package|Package $pkg)
Get the list of permission keys defined by a package.
Note, this queries both the pkgID found on the PermissionKeys table AND any permission keys of a special type installed by that package, and any in categories by that package.
in
Key at line 420
static Key
import(SimpleXMLElement $pk)
Import a permission key from a SimpleXMLElement element.
in
Key at line 447
static Key|null
getByID(int $pkID)
Get a permission key given its ID.
in
Key at line 472
static Key|null
getByHandle(string $pkHandle)
Get a permission key given its handle.
in
Key at line 501
static
add(string $pkCategoryHandle, string $pkHandle, string $pkName, string $pkDescription, bool $pkCanTriggerWorkflow, bool $pkHasCustomClass, Package|Package|null $pkg = false)
Adds an permission key.
in
Key at line 527
setPermissionKeyHasCustomClass(bool $pkHasCustomClass)
Mark this permission key as having (or not) a custom class.
in
Key at line 538
can()
deprecated
deprecated
No description
in
Key at line 581
delete()
Delete this permission key.
in
Key at line 594
ListItem[]
getAccessListItems()
A shortcut for grabbing the current assignment and passing into that object.
in
Key at line 618
Assignment
getPermissionAssignmentObject()
No description
in
Key at line 637
Access|null
getPermissionAccessObject()
No description
in
Key at line 647
int|null
getPermissionAccessID()
No description
in
Key at line 657
exportAccess(SimpleXMLElement $pxml)
No description
in
Key at line 667
static Translations
exportTranslations()
Export the strings that should be translated.
in
Key at line 692
static protected Key|null
load(int|mixed $key, string $loadBy = 'pkID')
Load a permission key by its ID (or whatever is passed to $loadBy).
copyFromPageToArea()
No description
protected int[]
getAllowedBlockTypeIDs()
deprecated
deprecated
No description
protected int[]
getAllowedBlockTypeIDsFor(string $operation)
Get the list of allowed block type IDs for a specific operation.