UserGroupsService

Type
Class
Namespace
Craft
Inherits
Craft\UserGroupsService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class UserGroupsService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()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()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
deleteGroupById()Deletes a user group by its ID.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()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()Checks if this application component has been initialized.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()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()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

Arguments

Returns

boolean – 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

Arguments

Returns

boolean – 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

Arguments

Returns

boolean

Signature

public boolean deleteGroupById ( $groupId )

getAllGroups()

Returns all user groups.

View source

Arguments

Returns

Craft\UserGroupModel[]

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

Arguments

  • $user (Craft\UserModel, null) – The recipient of the user groups. If set, their current groups will be included as well.

Returns

Craft\UserGroupModel[]

Signature

public Craft\UserGroupModel[] getAssignableGroups ( Craft\UserModel $user = null )

getGroupByHandle()

Gets a user group by its handle.

View source

Arguments

Returns

Craft\UserGroupModel

Signature

public Craft\UserGroupModel getGroupByHandle ( $groupHandle )

getGroupById()

Gets a user group by its ID.

View source

Arguments

Returns

Craft\UserGroupModel

Signature

public Craft\UserGroupModel getGroupById ( $groupId )

getGroupsByUserId()

Gets user groups by a user ID.

View source

Arguments

Returns

array

Signature

public array getGroupsByUserId ( $userId, $indexBy = null )

onAssignUserToDefaultGroup()

Fires an 'onAssignUserToDefaultGroup' event.

View source

Arguments

Returns

null

Signature

public null onAssignUserToDefaultGroup ( Craft\Event $event )

onAssignUserToGroups()

Fires an 'onAssignUserToGroups' event.

View source

Arguments

Returns

null

Signature

public null onAssignUserToGroups ( Craft\Event $event )

onBeforeAssignUserToDefaultGroup()

Fires an 'onBeforeAssignUserToDefaultGroup' event.

View source

Arguments

Returns

null

Signature

public null onBeforeAssignUserToDefaultGroup ( Craft\Event $event )

onBeforeAssignUserToGroups()

Fires an 'onBeforeAssignUserToGroups' event.

View source

Arguments

Returns

null

Signature

public null onBeforeAssignUserToGroups ( Craft\Event $event )

saveGroup()

Saves a user group.

View source

Arguments

Returns

boolean

Signature

public boolean saveGroup ( Craft\UserGroupModel $group )