# Documentation

# Ion Auth

Ion Auth is a simple and lightweight authentication library for the CodeIgniter framework

## License

Ion Auth is released under the Apache License v2.0. You can read the license here: http://www.apache.org/licenses/LICENSE-2.0

## Installation

1. Download the latest version: http://github.com/benedmunds/CodeIgniter-Ion-Auth/zipball/master
2. Copy the files from this package to the correspoding folder in your application folder. For example, copy Ion_auth/config/ion_auth.php to system/application/config/ion_auth.php.

The default login is:

- Email: admin@admin.com
- Password: password

## Loading Ion Auth

You load Ion Auth just link any other library:

    $this->load->library('ion_auth');

You can also autoload the library.

## Configuration Options

Ion Auth is extremely configurable. The following configuration options are available:

- $config['tables']['groups']
- $config['tables']['users']
- $config['tables']['users_groups']
- $config['tables']['login_attempts']
- $config['site_title']
- $config['admin_email']
- $config['default_group']
- $config['admin_group']
- $config['join']['users']
- $config['join']['groups']
- $config['identity']
- $config['min_password_length']
- $config['max_password_length']
- $config['email_activation']
- $config['remember_users']
- $config['user_expire']
- $config['user_extend_on_login']
- $config['email_type']
- $config['email_templates']
- $config['email_activate']
- $config['email_forgot_password']
- $config['email_forgot_password_complete']
- $config['salt_length']
- $config['store_salt']
- $config['forgot_password_expiration']
- $config['track_login_attempts']
- $config['maximum_login_attempts']
- $config['message_start_delimiter']
- $config['message_end_delimiter']
- $config['error_start_delimiter']
- $config['error_end_delimiter']

## Using Config File

To change configuration options simply edit the config/ion_auth.php file.

### Config

Edit the ion_auth $config array as needed:

- 'tables['groups']' - The table name to use for the groups table. DEFAULT is 'groups'.
- 'tables['users']' - The table name to use for the users table. DEFAULT is 'users'.
- 'tables['users_groups']' - The table name to use for the users groups table. DEFAULT is 'users_groups'.
- 'tables['login_attempts']' - The table name to use for the login attempts table. DEFAULT is 'login_attempts'.
- 'site_title' - The title of your site, used for email.
- 'admin_email' - Your administrator email address. DEFAULT is 'admin@example.com'.
- 'default_group' - Name of the default user group. DEFAULT is 'members'.
- 'admin_group' - Name of the admin group. DEFAULT is 'admin'.
- 'join['users'] ' - Users table column you want to join WITH. DEFAULT is 'user_id'.
- 'join['groups'] ' - Group table column you want to join WITH. DEFAULT is 'group_id'.
- 'identity' - Column to use for uniquely identifing user/logging in/etc. Usual choices are 'email' OR 'username'. You should add an index in the users table for whatever you set this option to. DEFAULT is 'email'.
- 'min_password_length' - Minimum length of passwords. DEFAULT is '8'.
- 'max_password_length' - Maximum length of passwords. DEFAULT is '20'.
- 'email_activation' - TRUE or FALSE. Sets whether to require email activation or not. DEFAULT is 'false'.
- 'remember_users' - TRUE or FALSE. Sets whether to enable 'remember me' functionality or not. DEFAULT is 'true'.
- 'user_expire' - Sets how long to remember the user for in seconds. Set to zero for no expiration. DEFAULT is '86500'.
- 'user_extend_on_login' - TRUE or FALSE. Extend the users session expiration on login. DEFAULT is 'false'.
- 'email_type' - Email content type. DEFAULT us 'html'.
- 'email_templates' - Folder where the email view templates are stored. DEFAULT is 'auth/email/'.
- 'email_activate' - Filname of the email activation view template. DEFAULT is 'activate.tpl.php'.
- 'email_forgot_password' - Filname of the forgot password email view template. DEFAULT is 'forgot_password.tpl.php'.
- 'email_forgot_password_complete' - Filname of the forgot password complete email view template. DEFAULT is 'new_password.tpl.php'.
- 'salt_length' - Length of the encryption salt. DEFAULT is '10'.
- 'store_salt' - TRUE or FALSE. Store the salt in a separate database column or not. This can be useful for integrating with existing apps. DEFAULT is 'false'.
- 'forgot_password_expiration' - Number of seconds before a forgot password request expires. If set to 0, requests will not expire. DEFAULT is 0.
- 'track_login_attempts' - Track the number of failed login attempts for each user or ip. DEFAULT is 'false'.
- 'maximum_login_attempts' - Set the maximum number of failed login attempts. This maximum is not enforced by the library, but is used by $this->ion_auth->is_max_login_attempts_exceeded(). The controller should check this function and act appropriately. If set to 0, there is no maximum. DEFAULT is 3.
- 'message_start_delimiter' - Starting delimiter for messages. DEFAULT is '<p>'.
- 'message_end_delimiter' - Ending delimiter for messages. DEFAULT is '</p>'.
- 'error_start_delimiter' - Starting delimiter for errors. DEFAULT is '<p>'.
- 'error_end_delimiter' - Ending delimiter for errors. DEFAULT is '</p>'.

# Class Function Reference

NOTE: Methods available in the model are called through the controller using PHP5 magic. You should never use ion_auth_model->method() in your applications.

## login()

Logs the user into the system.

Parameters

1. 'Username' - string REQUIRED. Usually username or email but depends on your config.
2. 'Password' - string REQUIRED.
3. 'Remember' - boolean OPTIONAL. TRUE sets the user to be remembered if enabled in the config

Return

- boolean. TRUE if the user was successfully logged in FALSE if the user was not logged in.

Usage

    		$identity = 'ben.edmunds@gmail.com';
    		$password = '12345678';
    		$remember = TRUE; // remember the user
    		$this->ion_auth->login($identity, $password, $remember);

## logout()

Logs the user out of the system.

Usage

    		$this->ion_auth->logout();

## register()

Register (create) a new user.

Parameters

1. 'Username' - string REQUIRED.
2. 'Password' - string REQUIRED.
3. 'Email' - string REQUIRED.
4. 'Additional Data' - multidimensional array REQUIRED.
5. 'Group' - array OPTIONAL. If not passed the default group name set in the config will be used.

Return

- mixed. The ID of the user if the user was successfully created, FALSE if the user was not created.

Usage

    		$username = 'benedmunds';
    		$password = '12345678';
    		$email = 'ben.edmunds@gmail.com';
    		$additional_data = array(
    								'first_name' => 'Ben',
    								'last_name' => 'Edmunds',
    								);
    		$group = array('1'); // Sets user to admin. No need for array('1', '2') as user is always set to member by default

    		$this->ion_auth->register($username, $password, $email, $additional_data, $group)

## update()

Update a user.

Parameters

1. 'Id' - integer REQUIRED.
2. 'Data' - multidimensional array REQUIRED.

Return

- boolean. TRUE if the user was successfully updated FALSE if the user was not updated.

Usage

    		$id = 12;
    		$data = array(
    					'first_name' => 'Ben',
    					'last_name' => 'Edmunds',
    					'password' => '123456789',
    					 );
    		$this->ion_auth->update($id, $data)

## delete_user()

Delete a user.

Parameters

1. 'Id' - integer REQUIRED.

Return

- boolean. TRUE if the user was successfully deleted FALSE if the user was not deleted.

Usage

    		$id = 12;
    		$this->ion_auth->delete_user($id)

## forgotten_password()

Resets a users password by emailing the user a reset code.

Parameters

1. 'Identity' - string REQUIRED. (as defined in config/ion_auth.php)

Return

- boolean. TRUE if the users password was successfully reset FALSE if the users password was not reset.

Usage

- this example assumes you have 'email' selected as the identity in config/ion_auth.php

    		//Working code for this example is in the example Auth controller in the github repo
    		function forgot_password()
    		{
    			$this->form_validation->set_rules('email', 'Email Address', 'required');
    			if ($this->form_validation->run() == false) {
    				//setup the input
    				$this->data['email'] = array('name'    => 'email',
    											 'id'      => 'email',
    											);
    				//set any errors and display the form
    				$this->data['message'] = (validation_errors()) ? validation_errors() : $this->session->flashdata('message');
    				$this->load->view('auth/forgot_password', $this->data);
    			}
    			else {
    				//run the forgotten password method to email an activation code to the user
    				$forgotten = $this->ion_auth->forgotten_password($this->input->post('email'));

    				if ($forgotten) { //if there were no errors
    					$this->session->set_flashdata('message', $this->ion_auth->messages());
    					redirect("auth/login", 'refresh'); //we should display a confirmation page here instead of the login page
    				}
    				else {
    					$this->session->set_flashdata('message', $this->ion_auth->errors());
    					redirect("auth/forgot_password", 'refresh');
    				}
    			}
    		}

## forgotten_password_complete()

Final step of resetting a users password. The user comes to this page from their email.

Parameters

1. 'Code' - string REQUIRED.

Return

- string. The users new password.

Usage

    		//Working code for this example is in the example Auth controller in the github repo
    		public function reset_password($code)
    		{
    			$reset = $this->ion_auth->forgotten_password_complete($code);

    			if ($reset) {  //if the reset worked then send them to the login page
    				$this->session->set_flashdata('message', $this->ion_auth->messages());
    				redirect("auth/login", 'refresh');
    			}
    			else { //if the reset didnt work then send them back to the forgot password page
    				$this->session->set_flashdata('message', $this->ion_auth->errors());
    				redirect("auth/forgot_password", 'refresh');
    			}
    		}

## logged_in()

Check to see if a user is logged in.

Return

- boolean. TRUE if the user is logged in FALSE if the user is not logged in.

Usage

    		if (!$this->ion_auth->logged_in())
    		{
    			redirect('auth/login');
    		}

## is_admin()

Check to see if the currently logged in user is an admin.

Parameters

1. 'id' - integer OPTIONAL. If a user id is not passed the id of the currently logged in user will be used.

Return

- boolean. TRUE if the user is an admin FALSE if the user is not an admin.

Usage

    		if (!$this->ion_auth->is_admin())
    		{
    			$this->session->set_flashdata('message', 'You must be an admin to view this page');
    			redirect('welcome/index');
    		}

## in_group()

Check to see if the currently logged in user is in the passed in group.

Parameters

1. 'Group Name' - string or array of strings REQUIRED.
2. 'User ID' - integer OPTIONAL. If a user id is not passed the id of the currently logged in user will be used.

Return

- boolean. TRUE if the user is in any of the given groups, FALSE otherwise.

Usage

    		# single group
    		$group = 'gangstas';
    		if (!$this->ion_auth->in_group($group))
    		{
    			$this->session->set_flashdata('message', 'You must be a gangsta to view this page');
    			redirect('welcome/index');
    		}

    		# multiple groups
    		$group = array('gangstas', 'hoodrats');
    		if (!$this->ion_auth->in_group($group))
    			$this->session->set_flashdata('message', 'You must be a gangsta OR a hoodrat to view this page');
    			redirect('welcome/index');
    		}

## username_check()

Check to see if the username is already registered.

Parameters

1. 'Username' - string REQUIRED.

Return

- boolean. TRUE if the user is registered FALSE if the user is not registered.

Usage

    		//This is a lame example but it works.  Usually you would use this method with form_validation.
    		$username = $this->input->post('username');
    		$password = $this->input->post('password');
    		$email = $this->input->post('email');
    		$additional_data = array(
    								'first_name' => $this->input->post('first_name'),
    								'last_name' => $this->input->post('last_name'),
    								);
    		if (!$this->ion_auth->username_check($username))
    		{
    			$group_name = 'users';
    			$this->ion_auth->register($username, $password, $email, $additional_data, $group_name)
    		}

## email_check()

Check to see if the email is already registered.

Parameters

1. 'Email' - string REQUIRED.

Return

- boolean. TRUE if the user is registered FALSE if the user is not registered.

Usage

    		//This is a lame example but it works.  Usually you would use this method with form_validation.
    		$username = $this->input->post('username');
    		$password = $this->input->post('password');
    		$email = $this->input->post('email');
    		$additional_data = array(
    								'first_name' => $this->input->post('first_name'),
    								'last_name' => $this->input->post('last_name'),
    								);
    		if (!$this->ion_auth->email_check($email))
    		{
    			$group_name = 'users';
    			$this->ion_auth->register($username, $password, $email, $additional_data, $group_name)
    		}

## identity_check()

Check to see if the identity is already registered.

Parameters

1. 'Identity' - string REQUIRED.

Return

- boolean. TRUE if the user is registered FALSE if the user is not registered.

Usage

    		//This is a lame example but it works.
    		$user = $this->ion_auth->user();
    		$data = array(
    					'identity' => $this->input->post('identity'),
    					'first_name' => $this->input->post('first_name'),
    					'last_name' => $this->input->post('last_name'),
    					 );
    		if ($data['identity'] === $user->username || $data['identity'] === $user->email || $this->ion_auth->identity_check($data['identity']) === FALSE)
    		{
    			$this->ion_auth->update_user($user->id, $data)
    		}

## is_max_login_attempts_exceeded()

If login attempt tracking is enabled, checks to see if the number of failed login attempts for this identity or ip address has been exceeded. The controller must call this method and take any necessary actions. Login attempt limits are not enforced in the library.

Parameters

1. 'Identity' - string REQUIRED.

Return

- boolean. TRUE if maximum_login_attempts is exceeded FALSE if not or if login attempts not tracked.

Usage

    		$identity = 'ben.edmunds@gmail.com';
    		if ($this->ion_auth->is_max_login_attempts_exceeded($identity))
    		{
    			$this->session->set_flashdata('message', 'You have too many login attempts');
    			redirect('welcome/index');
    		}

## get_attempts_num()

Returns the number of failed login attempts for this identity or ip address.

Parameters

1. 'Identity' - string REQUIRED.

Return

- int. The number of failed login attempts for this identity or ip address.

Usage

    		$identity = 'ben.edmunds@gmail.com';
    		$num_attempts = $this->ion_auth->get_attempts_num($identity);

## increase_login_attempts()

If login attempt tracking is enabled, records another failed login attempt for this identity or ip address. This method is automatically called during the login() method if the login failed.

Parameters

1. 'Identity' - string REQUIRED.

Usage

    		$identity = 'ben.edmunds@gmail.com';
    		$password = '12345678';
    		if ($this->ion_auth->login($identity, $password) == FALSE) {
    			$this->ion_auth->increase_login_attempts($identity)
    		}

## clear_login_attempts()

Clears all failed login attempt records for this identity or this ip address. This method is automatically called during the login() method if the login succeded.

Parameters

1. 'Identity' - string REQUIRED.

Usage

    		$identity = 'ben.edmunds@gmail.com';
    		$password = '12345678';
    		if ($this->ion_auth->login($identity, $password) == TRUE) {
    			$this->ion_auth->clear_login_attempts($identity)
    		}

## user()

Get a user.

Parameters

1. 'Id' - integer OPTIONAL. If a user id is not passed the id of the currently logged in user will be used.

Return

-     			stdClass Object (
      				[id] => 1
      				[ip_address] => 127.0.0.1
      				[username] => administrator
      				[password] => 59beecdf7fc966e2f17fd8f65a4a9aeb09d4a3d4
      				[salt] => 9462e8eee0
      				[email] => admin@admin.com
      				[activation_code] => 19e181f2ccc2a7ea58a2c0aa2b69f4355e636ef4
      				[forgotten_password_code] => 81dce1d0bc2c10fbdec7a87f1ff299ed7e4c9e4a
      				[remember_code] => 9d029802e28cd9c768e8e62277c0df49ec65c48c
      				[created_on] => 1268889823
      				[last_login] => 1279464628
      				[active] => 0
      				[first_name] => Admin
      				[last_name] => Account
      				[company] => Some Corporation
      				[phone] => (123)456-7890
      			)

Usage

    		$user = $this->ion_auth->user()->row();
    		echo $user->email;

## users()

Get the users.

Parameters

1. 'Group IDs' - array OPTIONAL. If an array of group ids are passed (or a single group id) this will return the users in those groups.

Return

- array of objects

Usage

    		$users = $this->ion_auth->users();

## group()

Get a group.

Parameters

1. 'Id' - integer REQUIRED.

Return

- object

Usage

    		$group_id = 2;
    		$group = $this->ion_auth->group($group_id);

## groups()

Get the groups.

Return

- array of objects

Usage

    		$groups = $this->ion_auth->groups();

## messages()

Get messages.

Return

- string

Usage

    		$id = 12;
    		$data = array(
    					'first_name' => 'Ben',
    					'last_name' => 'Edmunds',
    					 );
    		if ($this->ion_auth->update_user($id, $data))
    		{
    			$messages = $this->ion_auth->messages();
    			echo $messages;
    		}
    		else
    		{
    			$errors = $this->ion_auth->errors();
    			echo $errors;
    		}

## get_users_groups()

Get all groups a user is part of.

Parameters

1. 'Id' - integer OPTIONAL. If a user id is not passed the id of the currently logged in user will be used.

Return

-     			stdClass Object (
      				[id] => 1
      				[name] => admins
      				[description] => Administrator
      			)

Usage

    		$user_groups = $this->ion_auth->get_users_groups($user->id)->result();

## remove_from_group()

Remove user from group(s)

Parameters

1. 'User_id' - integer REQUIRED.

Return

- boolean. TRUE if the user was removed from group(s) FALSE if the user is not removed from group(s).

Usage

            // pass an array of group ID's and user ID
            $this->ion_auth->remove_from_group(array('1', '3', '6'), $user_id);

            // pass a single ID and user ID
            $this->ion_auth->remove_from_group(1, $user_id);

            // pass NULL to remove user from all groups
            $this->ion_auth->remove_from_group(NULL, $user_id);

## set_message_delimiters()

Set the message delimiters.

Parameters

1. 'Start Delimiter' - string REQUIRED.
2. 'End Delimiter' - string REQUIRED.

Usage

    		$id = 12;
    		$data = array(
    					'first_name' => 'Ben',
    					'last_name' => 'Edmunds',
    					 );
    		if ($this->ion_auth->update_user($id, $data))
    		{
    			$this->ion_auth->set_message_delimiters('<p><strong>','</strong></p>');
    			$messages = $this->ion_auth->messages();
    			echo $messages;
    		}
    		else
    		{
    			$this->ion_auth->set_error_delimiters('<p><strong>','</strong></p>');
    			$errors = $this->ion_auth->errors();
    			echo $errors;
    		}

## errors()

Get the errors.

Return

- string

Usage

    		$id = 12;
    		$data = array(
    					'first_name' => 'Ben',
    					'last_name' => 'Edmunds',
    					 );
    		if ($this->ion_auth->update_user($id, $data))
    		{
    			$messages = $this->ion_auth->messages();
    			echo $messages;
    		}
    		else
    		{
    			$errors = $this->ion_auth->errors();
    			echo $errors;
    		}

## set_error_delimiters()

Set the error delimiters.

Parameters

1. 'Start Delimiter' - string REQUIRED.
2. 'End Delimiter' - string REQUIRED.

Usage

    		$id = 12;
    		$data = array(
    					'first_name' => 'Ben',
    					'last_name' => 'Edmunds',
    					 );
    		if ($this->ion_auth->update_user($id, $data))
    		{
    			$this->ion_auth->set_message_delimiters('<p><strong>','</strong></p>');
    			$messages = $this->ion_auth->messages();
    			echo $messages;
    		}
    		else
    		{
    			$this->ion_auth->set_error_delimiters('<p><strong>','</strong></p>');
    			$errors = $this->ion_auth->errors();
    			echo $errors;
    		}

## set_hook()

Set a single or multiple functions to be called when trigged by trigger_events(). See an example here: http://gist.github.com/657de89b26decda2b2fa

Parameters

1. 'Event' - string REQUIRED.
2. 'Name' - string REQUIRED.
3. 'Class' - string REQUIRED.
4. 'Method' - string REQUIRED.
5. 'Arguments' - Array OPTIONAL.

Usage

    	class Accounts extends CI_Controller {

        public function __construct()
        {
          parent::__construct();

    			/*
          	make sure we loaded ion_auth2
            The following does not need to go in __construct() it just needs to be set before
            you trigger_events().
          */
          $event = 'socialpush';
          $class = 'Accounts';
          $args = array('this is the content of the message', 'billy');

          $name = 'activate_sendmail';
          $method = 'email';
          $this->ion_auth->set_hook($event, $name, $class, $method, $args);
          $name = 'call_Twitter';
          $method = 'twitter';
          $this->ion_auth->set_hook($event, $name, $class, $method, $args);
          $name = 'call_MailChimp_API';
          $method = 'mailchimp';
          $this->ion_auth->set_hook($event, $name, $class, $method, $args);
          $name = 'call_Facebook_API';
          $method = 'facebook';
          $this->ion_auth->set_hook($event, $name, $class, $method, $args);
          $name = 'call_gPlus_API';
          $method = 'gplus';
          $this->ion_auth->set_hook($event, $name, $class, $method, $args);
        }

        public function Post_Message($one)
        {
          $this->ion_auth->trigger_events('socialpush');
        }
        public function email($content, $who)
        {
        	return true;
        }
        public function twitter($content, $who)
        {
          return true;
        }
        public function mailchimp($content, $who)
        {
        	return true;
        }
        public function facebook($content, $who)
        {
        	return true;
        }
        public function gplus($content, $who)
        {
        	return true;
        }
      }

## trigger_events()

Call Additional functions to run that were registered with set_hook().

Parameters

1. 'Name' - String or Array REQUIRED.

Usage

    	 $this->ion_auth->trigger_events('socialpush');