UserGroupsService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\UserGroupsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class UserGroupsService
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. |
| assignUserToDefaultGroup() | Assigns a user to the default user group. |
| assignUserToGroups() | Assigns a user to a given list of user groups. |
| 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. |
| deleteGroupById() | Deletes a user group by its ID. |
| 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. |
| 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. |
| getAllGroups() | Returns all user groups. |
| getAssignableGroups() | Returns the user groups 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. |
| getGroupByHandle() | Gets a user group by its handle. |
| getGroupById() | Gets a user group by its ID. |
| getGroupsByUserId() | Gets user groups by a user ID. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| 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. |
| onAssignUserToDefaultGroup() | Fires an 'onAssignUserToDefaultGroup' event. |
| onAssignUserToGroups() | Fires an 'onAssignUserToGroups' event. |
| onBeforeAssignUserToDefaultGroup() | Fires an 'onBeforeAssignUserToDefaultGroup' event. |
| onBeforeAssignUserToGroups() | Fires an 'onBeforeAssignUserToGroups' event. |
| raiseEvent() (opens new window) | Raises an event. |
| saveGroup() | Saves a user group. |
# assignUserToDefaultGroup()
Assigns a user to the default user group. This method is called toward the end of a public registration request.
View source (opens new window)
Arguments
$user(Craft\UserModel) – The user that was just registered.
Returns
boolean (opens new window) – Whether the user was assigned to the default group.
Signature
public boolean assignUserToDefaultGroup ( Craft\UserModel $user )
# assignUserToGroups()
Assigns a user to a given list of user groups.
View source (opens new window)
Arguments
$userId(integer (opens new window)) – The user’s ID.$groupIds(integer (opens new window), array (opens new window)) – The groups’ IDs.
Returns
boolean (opens new window) – Whether the users were successfully assigned to the groups.
Signature
public boolean assignUserToGroups ( $userId, $groupIds = null )
# deleteGroupById()
Deletes a user group by its ID.
View source (opens new window)
Arguments
$groupId(integer (opens new window))
Returns
Signature
public boolean deleteGroupById ( $groupId )
# getAllGroups()
Returns all user groups.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public Craft\UserGroupModel[] getAllGroups ( $indexBy = null )
# getAssignableGroups()
Returns the user groups 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 user groups. If set, their current groups will be included as well.
Returns
Signature
public Craft\UserGroupModel[] getAssignableGroups ( Craft\UserModel $user = null )
# getGroupByHandle()
Gets a user group by its handle.
View source (opens new window)
Arguments
$groupHandle(integer (opens new window))
Returns
Signature
public Craft\UserGroupModel getGroupByHandle ( $groupHandle )
# getGroupById()
Gets a user group by its ID.
View source (opens new window)
Arguments
$groupId(integer (opens new window))
Returns
Signature
public Craft\UserGroupModel getGroupById ( $groupId )
# getGroupsByUserId()
Gets user groups by a user ID.
View source (opens new window)
Arguments
$userId(integer (opens new window))$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getGroupsByUserId ( $userId, $indexBy = null )
# onAssignUserToDefaultGroup()
Fires an 'onAssignUserToDefaultGroup' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onAssignUserToDefaultGroup ( Craft\Event $event )
# onAssignUserToGroups()
Fires an 'onAssignUserToGroups' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onAssignUserToGroups ( Craft\Event $event )
# onBeforeAssignUserToDefaultGroup()
Fires an 'onBeforeAssignUserToDefaultGroup' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeAssignUserToDefaultGroup ( Craft\Event $event )
# onBeforeAssignUserToGroups()
Fires an 'onBeforeAssignUserToGroups' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeAssignUserToGroups ( Craft\Event $event )
# saveGroup()
Signature
public boolean saveGroup ( Craft\UserGroupModel $group )