1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Permission
  7. \
  8. Key
  9. \
  10. FileKey

FileKey

class FileKey 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

from ConcreteObject
isError()

No description

from ConcreteObject
getError()

No description

from ConcreteObject
setPropertiesFromArray($arr)

No description

from ConcreteObject
static 
camelcase($file)

No description

from ConcreteObject
static 
uncamelcase($string)

No description

from ConcreteObject
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
getPermissionKeyCategoryHandle()

No description

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

delete()

No description

from Key
getAccessListItems()

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

from Key
Assignment
getPermissionAssignmentObject()

No description

from Key
getPermissionAccessObject()

No description

from Key
getPermissionAccessID()

No description

from Key
exportAccess($pxml)

No description

from Key
static 
exportTranslations()

No description

from Key
copyFromFileSetToFile()

No description

Details

in ConcreteObject at line 10
loadError($error)

Parameters

$error

in ConcreteObject at line 15
isError()

in ConcreteObject at line 25
getError()

in ConcreteObject at line 30
setPropertiesFromArray($arr)

Parameters

$arr

in ConcreteObject at line 37
static camelcase($file)

Parameters

$file

in ConcreteObject at line 42
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.

in Key at line 100
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

in Key at line 115
getPermissionKeyID()

Returns the ID for this permission key.

in Key at line 120
getPermissionKeyCategoryID()

in Key at line 125
getPermissionKeyCategoryHandle()

in Key at line 130
setPermissionObject($object)

Parameters

$object

in Key at line 135
getPermissionObjectToCheck()

in Key at line 144
getPermissionObject()

in Key at line 149
static loadAll()

in Key at line 176
static protected load($key, $loadBy = 'pkID')

Parameters

$key
$loadBy

in Key at line 201
hasCustomOptionsForm()

in Key at line 210
getPackageID()

in Key at line 215
getPackageHandle()

in Key at line 223
static getList($pkCategoryHandle, $filters = array())

Returns a list of all permissions of this category.

Parameters

$pkCategoryHandle
$filters

in Key at line 243
export($axml)

Parameters

$axml

in Key at line 257
static exportList($xml)

Parameters

$xml

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.

Parameters

$pkg

in Key at line 298
static import(SimpleXMLElement $pk)

Parameters

SimpleXMLElement $pk

in Key at line 319
static getByID($pkID)

Parameters

$pkID

in Key at line 329
static getByHandle($pkHandle)

Parameters

$pkHandle

in Key at line 342
static add($pkCategoryHandle, $pkHandle, $pkName, $pkDescription, $pkCanTriggerWorkflow, $pkHasCustomClass, $pkg = false)

Adds an permission key.

Parameters

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

in Key at line 383
setPermissionKeyHasCustomClass($pkHasCustomClass)

Parameters

$pkHasCustomClass

in Key at line 393
can()

Legacy support.

at line 12
validate()

in Key at line 432
delete()

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()

Return Value

Assignment

in Key at line 470
getPermissionAccessObject()

in Key at line 477
getPermissionAccessID()

in Key at line 485
exportAccess($pxml)

Parameters

$pxml

in Key at line 490
static exportTranslations()

at line 40
copyFromFileSetToFile()