Navigation

Search

setPermissionLevel

Description

Internal function used to set up pre-defined permissions levels.

Syntax

void setPermissionLevel (string $level[, mixed $group[, mixed $profile]])



Parameter $level

Expected type: Enumerated String
Description: The permissions level

Possible string values
Allowed values Description
'free' Every available board-level permission
'locked' General board-viewing permissions [board-level]
'maintenance' Higher-level permissions [group-level]
'moderator' Moderator permissions [group-level]
'publisher' General posting permissions [board-level]
'restrict' Restrictive (guest) permissions [group-level]
'standard' Standard (members) permissions [group-level] / nothing above group level [board-level]



Parameter $group

Expected type: Mixed
Description: The ID of the group we're setting permissions for, or null to set permissions for all groups

Allowed types for $group
Allowed values Description
Null Indicates that we're setting permissions for all groups
Integer The ID of the group we're setting permissions for



Parameter $profile

Expected type: Mixed
Description: The permissions profile being used

Allowed types for $profile
Allowed values Description
Null Specifies that we're setting permissions for a specific group ($group will have the group ID)
Integer If $group is null, indicates that we're saving this profile for all groups; otherwise indicates that we're saving this profile for the specified group


Notes

  • $profile and $group are both optional, but at least one must be set
View all versions of this function