UserPermissions

Type: Class
Namespace: craft\services
Inherits: craft\services\UserPermissions » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
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
assignablePermissions	array
behaviors	yii\base\Behavior – List of behaviors attached to this component

# `allPermissions`

Type: array
Default value: null
Access: Read-only

View source

# `assignablePermissions`

Type: array
Default value: null
Access: Read-only

View source

# Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of an object property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets value of an object property.
__unset()	Sets an object property to null.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	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()	Makes sure that the behaviors declared in behaviors() 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()	Returns the named behavior object.
getBehaviors()	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()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined.
init()	Initializes the object.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
saveGroupPermissions()	Saves new permissions for a user group.
saveUserPermissions()	Saves new permissions for a user.
trigger()	Triggers an event.