Class Key

Concrete\Core\Foundation\Object
Extended by Concrete\Core\Permission\Key\Key
Abstract
Namespace: Concrete\Core\Permission\Key
Located at src/Permission/Key/Key.php

Methods summary

public
public
# canPermissionKeyTriggerWorkflow( )

Returns whether a permission key can start a workflow.

public
# permissionKeyHasCustomClass( )

Returns whether a permission key has a custom class.

public
# getPermissionKeyName( )

Returns the name for this permission key.

public string
# getPermissionKeyDisplayName( string $format = 'html' )

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

public
# getPermissionKeyHandle( )

Returns the handle for this permission key.

public
# getPermissionKeyDescription( )

Returns the description for this permission key.

public string
# getPermissionKeyDisplayDescription( string $format = 'html' )

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

public
# getPermissionKeyID( )

Returns the ID for this permission key.

public
public
public
# setPermissionObject( $object )
public
public
public static
# loadAll( )
protected static
# load( $key, $loadBy = 'pkID' )
public
public
public
public static
# getList( $pkCategoryHandle, $filters = array() )

Returns a list of all permissions of this category.

public
# export( $axml )
public static
# exportList( $xml )
public 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.

public static
# import( SimpleXMLElement $pk )
public static
# getByID( $pkID )
public static
# getByHandle( $pkHandle )
public static
# add( $pkCategoryHandle, $pkHandle, $pkName, $pkDescription, $pkCanTriggerWorkflow, $pkHasCustomClass, $pkg = false )

Adds an permission key.

public
# setPermissionKeyHasCustomClass( $pkHasCustomClass )
public
# can( )

Legacy support.

public
# validate( )
public
# delete( )
public
# getAccessListItems( )

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

public
public
public
public
# exportAccess( $pxml )
public static

Constants summary

integer ACCESS_TYPE_INCLUDE
# 10
integer ACCESS_TYPE_EXCLUDE
# -1
integer ACCESS_TYPE_ALL
# 0

Properties summary

protected $permissionObject
# null

Properties inherited from Concrete\Core\Foundation\Object

$error