API16:JUserHelper/activateUser

Description

Method to activate a user

{{subst:Description:JUserHelper/activateUser}}

Syntax

static activateUser($activation)

Parameter Name	Default Value	Description
$activation		$activation Activation string

Returns

boolean True on success

Defined in

libraries/joomla/user/helper.php

Importing

jimport( 'joomla.user.helper' );

Source Body

public static function activateUser($activation)
{
        // Initialize some variables.
        $db = & JFactory::getDbo();

        // Lets get the id of the user we want to activate
        $query = 'SELECT id'
        . ' FROM #__users'
        . ' WHERE activation = '.$db->Quote($activation)
        . ' AND block = 1'
        . ' AND lastvisitDate = '.$db->Quote('0000-00-00 00:00:00');
        ;
        $db->setQuery($query);
        $id = intval($db->loadResult());

        // Is it a valid user to activate?
        if ($id)
        {
                $user = &JUser::getInstance((int) $id);

                $user->set('block', '0');
                $user->set('activation', '');

                // Time to take care of business.... store the user.
                if (!$user->save())
                {
                        JError::raiseWarning("SOME_ERROR_CODE", $user->getError());
                        return false;
                }
        }
        else
        {
                JError::raiseWarning("SOME_ERROR_CODE", JText::_('UNABLE TO FIND A USER WITH GIVEN ACTIVATION STRING'));
                return false;
        }

        return true;
}

{{subst:SeeAlso:JUserHelper/activateUser}}

Examples

<CodeExamplesForm />