CRM_Core_Permission_Base

class CRM_Core_Permission_Base

Properties

array $permissions permission mapping to stub check() calls

Methods

NULL|string
translatePermission(string $perm, string $nativePrefix, array $map)

Translate permission.

string
getPermission()

Get the current permission of this user.

string
whereClause(int $type, array $tables, array $whereTables)

Get the permissioned where clause for the user.

string
getPermissionedStaticGroupClause(int $type, array $tables, array $whereTables)

Get the permissioned where clause for the user when trying to see groups.

array
group(string $groupType = NULL, bool $excludeHidden = TRUE)

Get all groups from database, filtered by permissions for this user

string
groupClause(int $type, array $tables, array $whereTables)

Get group clause for this user.

check(string $str, int $userId = NULL)

Given a permission string, check for access requirements

bool
checkGroupRole(array $array)

Given a roles array, check for access requirements

permissionEmails(string $permissionName)

Get all the contact emails for users that have a specific permission.

roleEmails(string $roleName)

Get all the contact emails for users that have a specific role.

bool
isModulePermissionSupported()

Determine whether the permission store allows us to store a list of permissions generated dynamically (eg by hook_civicrm_permissions.)

upgradePermissions(array $permissions)

Ensure that the CMS supports all the permissions defined by CiviCRM and its extensions. If there are stale permissions, they should be deleted. This is useful during module upgrade when the newer module version has removed permission that were defined in the older version.

static array
getModulePermissions($module)

Get the permissions defined in the hook_civicrm_permission implementation of the given module.

array
getAllModulePermissions(bool $descriptions = FALSE)

Get the permissions defined in the hook_civicrm_permission implementation in all enabled CiviCRM module extensions.

Details

at line 61
NULL|string translatePermission(string $perm, string $nativePrefix, array $map)

Translate permission.

Parameters

string $perm Permission string e.g "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:action:com_asset"
string $nativePrefix
array $map Array($portableName => $nativeName).

Return Value

NULL|string a permission name

at line 85
string getPermission()

Get the current permission of this user.

Return Value

string the permission of the user (edit or view or null)

at line 102
string whereClause(int $type, array $tables, array $whereTables)

Get the permissioned where clause for the user.

Parameters

int $type The type of permission needed.
array $tables (reference ) add the tables that are needed for the select clause.
array $whereTables (reference ) add the tables that are needed for the where clause.

Return Value

string the group where clause for this user

at line 119
string getPermissionedStaticGroupClause(int $type, array $tables, array $whereTables)

Get the permissioned where clause for the user when trying to see groups.

Parameters

int $type The type of permission needed.
array $tables (reference ) add the tables that are needed for the select clause.
array $whereTables (reference ) add the tables that are needed for the where clause.

Return Value

string the group where clause for this user

at line 137
array group(string $groupType = NULL, bool $excludeHidden = TRUE)

Get all groups from database, filtered by permissions for this user

Parameters

string $groupType Type of group(Access/Mailing).
bool $excludeHidden exclude hidden groups.

Return Value

array array reference of all groups.

at line 154
string groupClause(int $type, array $tables, array $whereTables)

Get group clause for this user.

Parameters

int $type The type of permission needed.
array $tables (reference ) add the tables that are needed for the select clause.
array $whereTables (reference ) add the tables that are needed for the where clause.

Return Value

string the group where clause for this user

at line 166
check(string $str, int $userId = NULL)

Given a permission string, check for access requirements

Parameters

string $str The permission to check.
int $userId

at line 179
bool checkGroupRole(array $array)

Given a roles array, check for access requirements

Parameters

array $array The roles to check.

Return Value

bool true if yes, else false

at line 190
permissionEmails(string $permissionName)

Get all the contact emails for users that have a specific permission.

Parameters

string $permissionName Name of the permission we are interested in.

at line 201
roleEmails(string $roleName)

Get all the contact emails for users that have a specific role.

Parameters

string $roleName Name of the role we are interested in.

at line 212
bool isModulePermissionSupported()

Determine whether the permission store allows us to store a list of permissions generated dynamically (eg by hook_civicrm_permissions.)

Return Value

bool

at line 228
upgradePermissions(array $permissions)

Ensure that the CMS supports all the permissions defined by CiviCRM and its extensions. If there are stale permissions, they should be deleted. This is useful during module upgrade when the newer module version has removed permission that were defined in the older version.

Parameters

array $permissions Same format as CRM_Core_Permission::getCorePermissions().

Exceptions

CRM_Core_Exception

See also

CRM_Core_Permission::getCorePermissions

at line 245
static array getModulePermissions($module)

Get the permissions defined in the hook_civicrm_permission implementation of the given module.

Note: At time of writing, this is only used with native extension-modules, so there's one, predictable calling convention (regardless of CMS).

Parameters

$module

Return Value

array Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().

See also

CRM_Core_Permission::getCorePermissions

at line 265
array getAllModulePermissions(bool $descriptions = FALSE)

Get the permissions defined in the hook_civicrm_permission implementation in all enabled CiviCRM module extensions.

Parameters

bool $descriptions

Return Value

array Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().