This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_PermissionKey

Concrete5_Library_Object
Extended by Object
Extended by Concrete5_Model_PermissionKey

Direct known subclasses

PermissionKey

Indirect known subclasses

AccessUserSearchUserPermissionKey, AddBlockBlockTypePermissionKey, BlockTypePermissionKey, ComposerPagePermissionKey, Concrete5_Model_AccessUserSearchUserPermissionKey, Concrete5_Model_AddBlockBlockTypePermissionKey, Concrete5_Model_AddBlockToAreaAreaPermissionKey, Concrete5_Model_AddFileFileSetPermissionKey, Concrete5_Model_AddSubpagePagePermissionKey, Concrete5_Model_AdminPermissionKey, Concrete5_Model_AreaPermissionKey, Concrete5_Model_AssignUserGroupsUserPermissionKey, AddBlockToAreaAreaPermissionKey, Concrete5_Model_BasicWorkflowPermissionKey, Concrete5_Model_BlockPermissionKey, Concrete5_Model_BlockTypePermissionKey, Concrete5_Model_ComposerPagePermissionKey, Concrete5_Model_EditPagePropertiesPagePermissionKey, Concrete5_Model_EditPageThemePagePermissionKey, Concrete5_Model_EditUserPropertiesUserPermissionKey, Concrete5_Model_FilePermissionKey, Concrete5_Model_FileSetPermissionKey, Concrete5_Model_MarketplaceNewsflowPermissionKey, AddFileFileSetPermissionKey, Concrete5_Model_PagePermissionKey, Concrete5_Model_SinglePagePermissionKey, Concrete5_Model_SitemapPermissionKey, Concrete5_Model_StackPermissionKey, Concrete5_Model_UserPermissionKey, Concrete5_Model_ViewUserAttributesUserPermissionKey, Concrete5_Model_WorkflowPermissionKey, EditPagePropertiesPagePermissionKey, EditPageThemePagePermissionKey, EditUserPropertiesUserPermissionKey, AddSubpagePagePermissionKey, FilePermissionKey, FileSetPermissionKey, MarketplaceNewsflowPermissionKey, PagePermissionKey, SinglePagePermissionKey, SitemapPermissionKey, StackPermissionKey, UserPermissionKey, ViewUserAttributesUserPermissionKey, WorkflowPermissionKey, AdminPermissionKey, AreaPermissionKey, AssignUserGroupsUserPermissionKey, BasicWorkflowPermissionKey, BlockPermissionKey

Abstract
Package: Utilities
Located at core/models/permission/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
# can( )
public
# validate( )
public
# delete( )
public
# getAccessListItems( )

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

public
public
public
public
# exportAccess( $pxml )

Constants summary

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

Properties summary

Properties inherited from Concrete5_Library_Object

$error