raystech/psu-passport

PSU Passport Authentication for Laravel

Maintainers

Details

github.com/raystech/psu-passport

Source

Issues

Installs: 20

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:laravel

v1.2.3 2018-01-25 21:25 UTC

Requires

  • php: ^7.0

MIT 53571e0adce7f0955fab4065328ccb569a0ffcbe

This package is auto-updated.

Last update: 2024-11-23 18:34:12 UTC

README

Hey! This package is still a Work in Progress. Files, instructions, and other stuff might change!

Installation

Require this package in your composer.json and update composer. This will download the package and PSU Passport.

composer require "raystech/psu-passport:^1.2"

If you're using Laravel 5.5 or higher you can skip the two config setups below.

Add the ServiceProvider to the providers array in config/app.php

Raystech\PSUPassport\PSUPassportServiceProvider::class,

You can use the facade for shorter code; if using Laravel 5.4 or lower, add this to your aliases:

'PSUPassport' => Raystech\PSUPassport\Facades\Passport::class,

Usage

Import to controller

use PSUPassport;

Basic example

Send credentials to authenticate

$credentials = ['username' => '', 'password' => ''];
$user = PSUPassport::authenticate($credentials);

Return authentication result

$user->auth();

Return user details object e.g.

  • username
  • title
  • firstname
  • lastname
  • gender
  • personal id
  • email
  • affiliation
  • campus
  • status
  • details(array)
$user->getUserDetails();

Return staff details array

$user->getStaffDetails();

Return user status e.g. Students, Staffs, Temporary Users

$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.

Credit