class GatheringKey extends Key (View source)

Constants

ACCESS_TYPE_INCLUDE

ACCESS_TYPE_EXCLUDE

ACCESS_TYPE_ALL

Properties

$error from ConcreteObject
protected $permissionObject from Key

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

getSupportedAccessTypes()

No description

from Key
canPermissionKeyTriggerWorkflow()

Returns whether a permission key can start a workflow.

from Key
permissionKeyHasCustomClass()

Returns whether a permission key has a custom class.

from Key
getPermissionKeyName()

Returns the name for this permission key.

from Key
string
getPermissionKeyDisplayName(string $format = 'html')

Returns the display name for this permission key (localized and escaped accordingly to $format)

from Key
getPermissionKeyHandle()

Returns the handle for this permission key.

from Key
getPermissionKeyDescription()

Returns the description for this permission key.

from Key
string
getPermissionKeyDisplayDescription(string $format = 'html')

Returns the display description for this permission key (localized and escaped accordingly to $format)

from Key
getPermissionKeyID()

Returns the ID for this permission key.

from Key
getPermissionKeyCategoryID()

No description

from Key
from Key
setPermissionObject($object)

No description

from Key
getPermissionObjectToCheck()

No description

from Key
getPermissionObject()

No description

from Key
static 
loadAll()

No description

from Key
static 
load($key, $loadBy = 'pkID')

No description

from Key
hasCustomOptionsForm()

No description

from Key
getPackageID()

No description

from Key
getPackageHandle()

No description

from Key
static 
getList($pkCategoryHandle, $filters = array())

Returns a list of all permissions of this category.

from Key
export($axml)

No description

from Key
static 
exportList($xml)

No description

from Key
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.

from Key
static 
import(SimpleXMLElement $pk)

No description

from Key
static 
getByID($pkID)

No description

from Key
static 
getByHandle($pkHandle)

No description

from Key
static 
add($pkCategoryHandle, $pkHandle, $pkName, $pkDescription, $pkCanTriggerWorkflow, $pkHasCustomClass, $pkg = false)

Adds an permission key.

from Key
setPermissionKeyHasCustomClass($pkHasCustomClass)

No description

from Key
can()

Legacy support.

from Key
validate()

No description

from Key
delete()

No description

from Key
getAccessListItems()

A shortcut for grabbing the current assignment and passing into that object.

from Key
getPermissionAccessObject()

No description

from Key
getPermissionAccessID()

No description

from Key
exportAccess($pxml)

No description

from Key
static 
exportTranslations()

No description

from Key
copyFromDefaultsToGathering(PermissionKey $pk)

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

in Key at line 24
getSupportedAccessTypes()

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)

Parameters

string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.

Return Value

string

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.

string getPermissionKeyDisplayDescription(string $format = 'html')

Returns the display description for this permission key (localized and escaped accordingly to $format)

Parameters

string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display description won't be escaped.

Return Value

string

getPermissionKeyID()

Returns the ID for this permission key.

getPermissionKeyCategoryID()

getPermissionKeyCategoryHandle()

setPermissionObject($object)

Parameters

$object

getPermissionObjectToCheck()

getPermissionObject()

static loadAll()

static protected load($key, $loadBy = 'pkID')

Parameters

$key
$loadBy

hasCustomOptionsForm()

getPackageID()

getPackageHandle()

static getList($pkCategoryHandle, $filters = array())

Returns a list of all permissions of this category.

Parameters

$pkCategoryHandle
$filters

export($axml)

Parameters

$axml

static exportList($xml)

Parameters

$xml

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.

Parameters

$pkg

static import(SimpleXMLElement $pk)

Parameters

SimpleXMLElement $pk

static getByID($pkID)

Parameters

$pkID

static getByHandle($pkHandle)

Parameters

$pkHandle

static add($pkCategoryHandle, $pkHandle, $pkName, $pkDescription, $pkCanTriggerWorkflow, $pkHasCustomClass, $pkg = false)

Adds an permission key.

Parameters

$pkCategoryHandle
$pkHandle
$pkName
$pkDescription
$pkCanTriggerWorkflow
$pkHasCustomClass
$pkg

setPermissionKeyHasCustomClass($pkHasCustomClass)

Parameters

$pkHasCustomClass

can()

Legacy support.

validate()

delete()

getAccessListItems()

A shortcut for grabbing the current assignment and passing into that object.

Assignment getPermissionAssignmentObject()

Return Value

Assignment

getPermissionAccessObject()

getPermissionAccessID()

exportAccess($pxml)

Parameters

$pxml

static exportTranslations()

copyFromDefaultsToGathering(PermissionKey $pk)

Parameters

PermissionKey $pk