UserPermissionsService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\UserPermissionsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class UserPermissionsService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| doesGroupHavePermission() | Returns whether a given user group has a given permission. |
| doesUserHavePermission() | Returns whether a given user has a given permission. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of 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. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getGroupPermissionsByUserId() | Returns all of the group permissions a given user has. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getPermissionsByGroupId() | Returns all of a given user group's permissions. |
| getPermissionsByUserId() | Returns all of a given user's permissions. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| raiseEvent() (opens new window) | Raises an event. |
| saveGroupPermissions() | Saves new permissions for a user group. |
| saveUserPermissions() | Saves new permissions for a user. |
# 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
Signature
public boolean doesGroupHavePermission ( $groupId, $checkPermission )
# 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
Signature
public boolean doesUserHavePermission ( $userId, $checkPermission )
# getAllPermissions()
Signature
public array getAllPermissions ( )
# getAssignablePermissions()
Returns the permissions that the current user is allowed to assign to another user.
View source (opens new window)
Arguments
$user(Craft\UserModel, null (opens new window)) – The recipient of the permissions. If set, their current permissions will be included as well.
Returns
Signature
public array getAssignablePermissions ( Craft\UserModel $user = null )
# getGroupPermissionsByUserId()
Returns all of the group permissions a given user has.
View source (opens new window)
Arguments
$userId(integer (opens new window))
Returns
Signature
public array getGroupPermissionsByUserId ( $userId )
# getPermissionsByGroupId()
Returns all of a given user group's permissions.
View source (opens new window)
Arguments
$groupId(integer (opens new window))
Returns
Signature
public array getPermissionsByGroupId ( $groupId )
# getPermissionsByUserId()
Returns all of a given user's permissions.
View source (opens new window)
Arguments
$userId(integer (opens new window))
Returns
Signature
public array getPermissionsByUserId ( $userId )
# saveGroupPermissions()
Saves new permissions for a user group.
View source (opens new window)
Arguments
$groupId(integer (opens new window))$permissions(array (opens new window))
Returns
Signature
public boolean saveGroupPermissions ( $groupId, $permissions )
# saveUserPermissions()
Saves new permissions for a user.
View source (opens new window)
Arguments
$userId(integer (opens new window))$permissions(array (opens new window))
Returns
Signature
public boolean saveUserPermissions ( $userId, $permissions )