codeigniter-smarty-acl

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

codeigniter-smarty-acl

★ 9 Open GitHub ↗

Lightweight Auth System with ACL for CodeIgniter 3

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Smarty ACL
SmartyACL is a library with basic authentication and authorization functions for Codeigniter 3. This library was based on Ion Auth but with the addition of ACL / RBAC and some other features.
  
### Features
- Register
  - Register admin or user
  - Send mail verification (optional)
- Login
  - Single or Multi login(email, username or both) 
  - Limit max attempts
  - Remember me
  - Checks account status(inactive or banned) (optional)
  - Check mail verification (optional)
- Forgot Password
  - Send reset password mail
- Reset Password
  - Validate security code and update user email/password
- Roles
  - Create, update, delete
  - Assign module permissions
- Modules
  - Create, update and delete
- Admin Group - Users with role/permission access
- User Group - Common users without role/permission access
- Cache data to improve performance (optional)
  
### Summary
- [Requirements](#requirements)
- [Demo](#demo)
- [Installation](#installation)
- [Default Login](#default-login)
- [Usage](#usage)
- [Contributing](#contributing)
- [Support](#support)
- [References](#references)
  
### Requirements
- Codeigniter 3 (developed on 3.1.11)
- PHP 7.x (developed on 7.3)

### Demo
Download a demo application [here](https://github.com/rubensrocha/codeigniter-smarty-acl-demo)

### Installation
1. Download latest released version
2. Put SmartyAcl folder on `application/third_party` directory
3. Add to `$autoload['packages']`¹ in `application/config/autoload.php`
    ```
    $autoload['packages'] = array(APPPATH.'third_party/SmartyAcl');
    ```
4. Import DB tables using migration or database.sql file
5. Config library preferences on `application/third_party/SmartyAcl/config/smarty_acl.php`

¹ Alternatively, you can copy the contents of the SmartyAcl folder to the respective directories in the application folder and load the library directly into the controller using `$this->load->library('smarty_acl');`

### Default Login
Username: admin 
Password: 123456
### Usage
Methods List

#### Register Admin
Call:
```php
$this->smarty_acl->register($identity, $password, $email, $additional_data, $role_id);
```
Responses:
```
int = user registered
array = user data array if verification is enabled but 'email_sender' is disabled
false(bool) = failed to register
```

#### Register User
Call:
```php
$this->smarty_acl->register_user($identity, $password, $email, $additional_data, $role_id);
```
Responses:
```
int = user registered
array = user data array if verification is enabled but 'email_sender' is disabled
false(bool) = failed to register
```

#### Login
Call:
```php
$this->smarty_acl->login($identity, $password, $remember, $admin);
```
Response:
```
(bool) = true if logged in
```

#### Activate Admin or user
Call:
```php
//Admin user
$this->smarty_acl->activate($user_id, $code);
//User
$this->smarty_acl->activate_user($user_id, $code);
```
Response:
```
(bool) = true if activated
```

| Field | Required | Info |
| :-----: | :--------: | :-------: |
| $user_id | yes | User ID |
| $code | yes | Activation Security Code |

#### Resend Activation Mail
Call:
```php
$this->smarty_acl->resend_activation($email, $admin);
```
Response:
```
(bool) = true if sent successfully
```

#### Forgotten Password
Call:
```php
$this->smarty_acl->forgotten_password($email, $admin);
```
Response:
```
(bool) = true if sent successfully
```

#### Forgotten Password Check
Call:
```php
$this->smarty_acl->forgotten_password_check($code, $admin);
```
Response:
```
(bool) = false if code is invalid or expired
(array) = user data array
```

#### Reset Password
Call:
```php
$this->smarty_acl->reset_password($user, $email, $password, $admin);
```
Response:
```
(bool) = true if updated successfully
```

#### Logged in
Call:
```php
$this->smarty_acl->logged_in($admin);
```
Response:
```
(bool) = true if user is logged in
```

#### Logout
Call:
```php
$this->smarty_acl->logout($admin);
```
Response:
```
(bool) = true if user is logged out
```

#### Get Roles
Call:
```php
$this->smarty_acl->roles($result);
```
Response:
```
Roles list as object or array
```

#### Create Role
Call:
```php
$this->smarty_acl->create_role($data);
```
Response:
```
(bool) = true if created
```

| Field | Required | Info |
| :-----: | :--------: | :-------: |
| $data | yes | array with role fields/values |

#### Get Role
Call:
```php
$this->smarty_acl->role($role_id);
```
Response:
```
(object) = if found
(bool) = false if not found
```