PSU Passport Authentication for Laravel 5
Hey! This package is still a Work in Progress. Files, instructions, and other stuff might change!, (*1)
Installation
Require this package in your composer.json and update composer. This will download the package and PSU Passport., (*2)
composer require "raystech/psu-passport:^1.2"
If you're using Laravel 5.5 or higher you can skip the two config setups below., (*3)
Add the ServiceProvider to the providers array in config/app.php, (*4)
Raystech\PSUPassport\PSUPassportServiceProvider::class,
You can use the facade for shorter code; if using Laravel 5.4 or lower, add this to your aliases:, (*5)
'PSUPassport' => Raystech\PSUPassport\Facades\Passport::class,
Usage
Import to controller, (*6)
use PSUPassport;
Basic example
Send credentials to authenticate, (*7)
$credentials = ['username' => '', 'password' => ''];
$user = PSUPassport::authenticate($credentials);
Return authentication result, (*8)
$user->auth();
Return user details object e.g.
- username
- title
- firstname
- lastname
- gender
- personal id
- email
- affiliation
- campus
- status
- details(array), (*9)
$user->getUserDetails();
Return staff details array, (*10)
$user->getStaffDetails();
Return user status e.g. Students, Staffs, Temporary Users, (*11)
$user->status();
License
This package is licensed under MIT. You can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source., (*12)
Credit
Wallogit.com
