UserPermissions

Type: Class
Namespace: craft\services
Inherits: craft\services\UserPermissions » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 3.0.0

User Permissions service.

An instance of the User Permissions service is globally accessible in Craft via Craft::$app->userPermissions.

# Public Properties

Property	Description
allPermissions	array (opens new window)
assignablePermissions	array (opens new window)
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component

# `allPermissions`

Type: array (opens new window)
Default value: null
Access: Read-only

View source (opens new window)

# `assignablePermissions`

Type: array (opens new window)
Default value: null
Access: Read-only

View source (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of an object property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets value of an object property.
__unset() (opens new window)	Sets an object property to null.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
doesGroupHavePermission()	Returns whether a given user group has a given permission.
doesUserHavePermission()	Returns whether a given user has a given permission.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getAllPermissions()	Returns all of the known permissions, sorted by category.
getAssignablePermissions()	Returns the permissions that the current user is allowed to assign to another user.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getGroupPermissionsByUserId()	Returns all of the group permissions a given user has.
getPermissionsByGroupId()	Returns all of a given user group's permissions.
getPermissionsByUserId()	Returns all of a given user's permissions.
handleChangedGroupPermissions()	Handle any changed group permissions.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined.
init() (opens new window)	Initializes the object.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
saveGroupPermissions()	Saves new permissions for a user group.
saveUserPermissions()	Saves new permissions for a user.
trigger() (opens new window)	Triggers an event.

# `doesGroupHavePermission()`

Returns whether a given user group has a given permission.

View source (opens new window)

Arguments

$groupId (integer (opens new window))
$checkPermission (string (opens new window))

Returns

boolean (opens new window)

# `doesUserHavePermission()`

Returns whether a given user has a given permission.

View source (opens new window)

Arguments

$userId (integer (opens new window))
$checkPermission (string (opens new window))

Returns

boolean (opens new window)

# `getAllPermissions()`

Returns all of the known permissions, sorted by category.

View source (opens new window)

Returns

array (opens new window)

# `getAssignablePermissions()`

Returns the permissions that the current user is allowed to assign to another user.

View source (opens new window)

Arguments

$user (craft\elements\User, null (opens new window)) – The recipient of the permissions. If set, their current permissions will be included as well.