1.8Documentation

// validate the a username and password
if ($user = Auth::validate_user($name, $pass))
{
    // the combination of $name and $pass validated, print the users screen name
    echo $user['username'];
}

// perform a login
if (Auth::login($name, $pass))
{
    // the user is succesfully logged in
}

// login if we're not logged-in
if ( ! Auth::check())
{
    Response::redirect('/login');
}

// perform a forced login for user 12121
if (Auth::force_login(12121))
{
    // the user is succesfully logged in. Any previously logged-in user will be logged out!
}

// perform a logout
Auth::logout();

// create a new user
Auth::create_user(
    'anewuser',
    'thisismysecretpassword',
    'anewuser@example.org',
    1,
    array(
        'fullname' => 'A. New User',
    )
);

// update the data for the current user
Auth::update_user(
    array(
        'email'        => 'anewemail@example.org',  // set a new email address
        'password'     => 'thisismynewpassword',    // set a new password
        'old_password' => 'thisismysecretpassword', // to do so, give the current one!
        'phone'        => '+1 (555) 123-1212',	    // and add the phone number to the metadata
    )
);

// change the password for the current user
Auth::change_password('mycurrentpassword','mynewpassword');

// reset the password for the current user
$new_password = Auth::reset_password('thisusername');

// delete the user
Auth::delete_user('thisusername');

// generate a new random hash
Auth::create_login_hash();

// get the user creation date
$created_at = Auth::get('created_at');

// get all login id information
$id_info = Auth::get_user_id();

// print driver and id info
if ($id_info)
{
    foreach ($id_info as $info)
    {
        echo 'Driver: ',$info[0],' with ID ',$info[1],'<br />';
    }
}
else
{
    echo 'Nobody is logged in!';
}

// if you only use one driver, you can also do
list($driver, $userid) = Auth::get_user_id();

// or this if you only need the userid
list(, $userid) = Auth::get_user_id();

// get all group id information
$id_info = Auth::get_groups();

// print driver and id info
if ($id_info)
{
    foreach ($id_info as $info)
    {
        echo 'Driver: ',$info[0],' with group ID ',$info[1],'<br />';
    }
}
else
{
    echo 'Nobody is logged in!';
}

// if you only use one driver, you can also do
list($driver, $groupid) = Auth::get_groups();

// get the current users email address
$email = Auth::get_email();

// note that there is a difference between false and empty:
if ($email === false)
{
    // nobody logged in
}
if (empty($email))
{
    // a user is logged in, but doesn't have an email address
}

// get the current users screen name
$name = Auth::get_screen_name();

// name is required, so if not present it means nobody is logged in
if (empty($name))
{
    // nobody logged in
}

// get all profile fields defined
$profile = Auth::get_profile_fields();

// Check if the current user is an administrator
if (Auth::member(100))
{
    // we are in the administrator group!
}

// Get all defined groups (for all loaded group drivers)
$groups = Auth::groups();

// Get all the groups from the default group driver
$groups = Auth::group()->groups();

// Get all the groups from a specific driver
$groups = Auth::group('Simplegroup')->groups();

// Get all defined roles (for all loaded acl drivers)
$roles = Auth::roles();

// Get all the roles from the default acl driver
$roles = Auth::acl()->roles();

// Get all the roles from a specific driver
$roles = Auth::acl('Simpleacl')->roles();

// Get all the name for the group of the current logged-in user
$name = Auth::group()->get_name();

// Get the name of a specific group from a specific driver
$name = Auth::group('Simplegroup')->get_name(100);	// returns 'Administrators'

// check if the user has access to read blog posts
if (Auth::has_access('blog.read'))
{
    // yes, the user has access
}

// if you have multiple login instances, use the instance to call this method.
// you can also check for multiple rights in one go
if (Auth::instance('simpleauth')->has_access('blog.[read,write,delete]'))
{
    // yes, the user has access and may read, write and delete
}

// you can also specify the rights to check as an array
if (Auth::has_access(array('blog' => array('read'), 'comments' => array('read')))
{
    // yes, the user has access to read blogs and comments
}

// if you have multiple login instances, you can also pick a specific ACL driver
if (Auth::acl('simpleacl')->has_access('blog.[read,write,delete]'))
{
    // yes, the user has access and may read, write and delete
}

// redirect to login if we we require a user and no guest access is enabled
if ( ! Auth::check() and ! Auth::guest_login())
{
    Response::redirect('/login');
}

// process the login form POST, and set the remember-me cookie if needed
if (\Input::method() == 'POST')
{
    // check the credentials.
    if (\Auth::instance()->login(\Input::param('username'), \Input::param('password')))
    {
        // does the user want to be remembered?
        if (\Input::param('rememberme', false))
        {
            // create the remember-me cookie
            \Auth::remember_me();
        }
        else
        {
            // delete the remember-me cookie if present
            \Auth::dont_remember_me();
        }

        // logged in, go the homepage
        \Response::redirect('/');
    }
    else
    {
        // login failed, show an error message
        $data['username']    = \Input::param('username');
        $data['login_error'] = \Lang::get('login.failure');
    }
}