Key
abstract class Key extends Object (View source)
Constants
| ACCESS_TYPE_INCLUDE |
|
| ACCESS_TYPE_EXCLUDE |
|
| ACCESS_TYPE_ALL |
|
Properties
| $error | from Object | ||
| protected | $permissionObject |
Methods
No description
Returns whether a permission key can start a workflow.
Returns whether a permission key has a custom class.
Returns the name for this permission key.
Returns the display name for this permission key (localized and escaped accordingly to $format)
Returns the handle for this permission key.
Returns the description for this permission key.
Returns the display description for this permission key (localized and escaped accordingly to $format)
Returns the ID for this permission key.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Returns a list of all permissions of this category.
No description
No description
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.
No description
No description
Adds an permission key.
No description
Legacy support.
No description
No description
A shortcut for grabbing the current assignment and passing into that object.
No description
No description
No description
No description
No description
Details
in
Object at line 10
loadError($error)
No description
in
Object at line 15
isError()
No description
in
Object at line 25
getError()
No description
in
Object at line 30
setPropertiesFromArray($arr)
No description
in
Object at line 37
static
camelcase($file)
No description
in
Object at line 42
static
uncamelcase($string)
No description
getSupportedAccessTypes()
No description
canPermissionKeyTriggerWorkflow()
Returns whether a permission key can start a workflow.
permissionKeyHasCustomClass()
Returns whether a permission key has a custom class.
getPermissionKeyName()
Returns the name for this permission key.
string
getPermissionKeyDisplayName(string $format = 'html')
Returns the display name for this permission key (localized and escaped accordingly to $format)
getPermissionKeyHandle()
Returns the handle for this permission key.
getPermissionKeyDescription()
Returns the description for this permission key.
string
getPermissionKeyDisplayDescription(string $format = 'html')
Returns the display description for this permission key (localized and escaped accordingly to $format)
getPermissionKeyID()
Returns the ID for this permission key.
getPermissionKeyCategoryID()
No description
getPermissionKeyCategoryHandle()
No description
setPermissionObject($object)
No description
getPermissionObjectToCheck()
No description
getPermissionObject()
No description
static
loadAll()
No description
static protected
load($key, $loadBy = 'pkID')
No description
hasCustomOptionsForm()
No description
getPackageID()
No description
getPackageHandle()
No description
static
getList($pkCategoryHandle, $filters = array())
Returns a list of all permissions of this category.
export($axml)
No description
static
exportList($xml)
No description
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.
static
import(SimpleXMLElement $pk)
No description
static
getByID($pkID)
No description
static
getByHandle($pkHandle)
No description
static
add($pkCategoryHandle, $pkHandle, $pkName, $pkDescription, $pkCanTriggerWorkflow, $pkHasCustomClass, $pkg = false)
Adds an permission key.
setPermissionKeyHasCustomClass($pkHasCustomClass)
No description
can()
Legacy support.
validate()
No description
delete()
No description
getAccessListItems()
A shortcut for grabbing the current assignment and passing into that object.
Assignment
getPermissionAssignmentObject()
No description
getPermissionAccessObject()
No description
getPermissionAccessID()
No description
exportAccess($pxml)
No description
static
exportTranslations()
No description