API16:JUserHelper/setUserGroups

Description

Method to set the groups for a user.

Syntax

static setUserGroups($userId, $groups)

Parameter Name	Default Value	Description
$userId		$userId The id of the user.
$groups		$groups An array of group ids to put the user in.

Returns

mixed Boolean true on success, on error.

Defined in

libraries/joomla/user/helper.php

Importing

jimport( 'joomla.user.helper' );

Source Body

public static function setUserGroups($userId, $groups)
{
        // Get the user object.
        $user = & JUser::getInstance((int) $userId);

        // Set the group ids.
        JArrayHelper::toInteger($groups);
        $user->groups = array_fill_keys(array_values($groups), null);

        // Get the titles for the user groups.
        $db = &JFactory::getDbo();
        $db->setQuery(
                'SELECT `id`, `title`' .
                ' FROM `#__usergroups`' .
                ' WHERE `id` = '.implode(' OR `id` = ', array_keys($user->groups))
        );
        $results = $db->loadObjectList();

        // Check for a database error.
        if ($db->getErrorNum()) {
                return new JException($db->getErrorMsg());
        }

        // Set the titles for the user groups.
        for ($i = 0, $n = count($results); $i < $n; $i++) {
                $user->groups[$results[$i]->id] = $results[$i]->title;
        }

        // Store the user object.
        if (!$user->save()) {
                return new JException($user->getError());
        }

        // Set the group data for any preloaded user objects.
        $temp = & JFactory::getUser((int) $userId);
        $temp->groups = $user->groups;

        // Set the group data for the user object in the session.
        $temp = & JFactory::getUser();
        if ($temp->id == $userId) {
                $temp->groups = $user->groups;
        }

        return true;
}