AddBlockToAreaAreaKey
class AddBlockToAreaAreaKey extends AreaKey (View source)
Constants
| ACCESS_TYPE_INCLUDE |
|
| ACCESS_TYPE_EXCLUDE |
|
| ACCESS_TYPE_ALL |
|
Properties
| $error | from ConcreteObject | ||
| protected | $permissionObject | from Key |
Methods
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 a list of all permissions of this category.
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.
Adds an permission key.
No description
A shortcut for grabbing the current assignment and passing into that object.
No description
No description
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 24
getSupportedAccessTypes()
No description
in
Key at line 37
canPermissionKeyTriggerWorkflow()
Returns whether a permission key can start a workflow.
in
Key at line 45
permissionKeyHasCustomClass()
Returns whether a permission key has a custom class.
in
Key at line 53
getPermissionKeyName()
Returns the name for this permission key.
in
Key at line 65
string
getPermissionKeyDisplayName(string $format = 'html')
Returns the display name for this permission key (localized and escaped accordingly to $format)
in
Key at line 80
getPermissionKeyHandle()
Returns the handle for this permission key.
in
Key at line 88
getPermissionKeyDescription()
Returns the description for this permission key.
in
Key at line 100
string
getPermissionKeyDisplayDescription(string $format = 'html')
Returns the display description for this permission key (localized and escaped accordingly to $format)
in
Key at line 115
getPermissionKeyID()
Returns the ID for this permission key.
in
Key at line 120
getPermissionKeyCategoryID()
No description
in
Key at line 125
getPermissionKeyCategoryHandle()
No description
in
Key at line 130
setPermissionObject($object)
No description
in
Key at line 135
getPermissionObjectToCheck()
No description
in
Key at line 144
getPermissionObject()
No description
in
Key at line 149
static
loadAll()
No description
in
Key at line 176
static protected
load($key, $loadBy = 'pkID')
No description
in
Key at line 201
hasCustomOptionsForm()
No description
in
Key at line 210
getPackageID()
No description
in
Key at line 215
getPackageHandle()
No description
in
Key at line 223
static
getList($pkCategoryHandle, $filters = array())
Returns a list of all permissions of this category.
in
Key at line 243
export($axml)
No description
in
Key at line 257
static
exportList($xml)
No description
in
Key at line 273
static
getListByPackage($pkg)
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 298
static
import(SimpleXMLElement $pk)
No description
in
Key at line 319
static
getByID($pkID)
No description
in
Key at line 329
static
getByHandle($pkHandle)
No description
in
Key at line 342
static
add($pkCategoryHandle, $pkHandle, $pkName, $pkDescription, $pkCanTriggerWorkflow, $pkHasCustomClass, $pkg = false)
Adds an permission key.
in
Key at line 383
setPermissionKeyHasCustomClass($pkHasCustomClass)
No description
in
Key at line 393
can()
Legacy support.
validate($bt = false)
No description
in
Key at line 432
delete()
No description
in
Key at line 442
getAccessListItems()
A shortcut for grabbing the current assignment and passing into that object.
in
Key at line 456
Assignment
getPermissionAssignmentObject()
No description
in
Key at line 470
getPermissionAccessObject()
No description
in
Key at line 477
getPermissionAccessID()
No description
in
Key at line 485
exportAccess($pxml)
No description
in
Key at line 490
static
exportTranslations()
No description
copyFromPageToArea()
No description
protected
getAllowedBlockTypeIDs()
No description