ajtarragona/tid

Laravel package for AOC valid authentication

Downloads

69

Stars

0

Version

v0.0.14

TID. Tarragona Identitat Digital

Paquet Laravel d'integració amb la plataforma Valid de l'AOC. Permet securitzar rutes mitjançant un middleware.

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require

Instalació

composer require ajtarragona/tid:"@dev"

Amb la següent comanda publiquem els recursos per què el formulari d'accés a Vàlid es mostri correctament.

php artisan vendor:publish --tag=ajtarragona-tid-assets --force

Configuració

Pots configurar el paquet a través de l'arxiu .env de l'aplicació. Aquests son els parámetres disponibles :

Paràmetre Descripció
VALID_CLIENT_ID Id de client Vàlid
VALID_CLIENT_SECRET Secret del client Vàlid
VALID_ENVIRONMENT Entorn 'pre' o 'pro'

Alternativament, pots publicar l'arxiu de configuració del paquet amb la comanda:

php artisan vendor:publish --tag=ajtarragona-tid-config

Això copiarà l'arxiu tid.php a la carpeta config.

Ús

Un cop configurat, el paquet està a punt per fer-se servir. Bàsicament el que ens caldrà és securitzar les rutes a través del middleware tid que proporciona el paquet:

Route::middleware(['tid'])->group( function () {
    Route::get('/test', 'TestTidController@page')->name('secure_page');
});

Si volguéssim revocar la sessió de l'usuari, tenim disponible una ruta GET: /ajtarragona/tid/logout que té el nom tid.logout

Podem accedir a la informació de l'usuari en sessió de diferents maneres:

A través d'una Facade:

use TID;
...
public  function  test(){
    $usuari=TID::getUser();
    ...
}

Per Laravel < 5.6, cal registrar l'alias de la Facade a l'arxiu config/app.php :

'aliases'  =>  [
    ...
    'TID'  =>  Ajtarragona\TID\Facades\TIDFacade::class
]

Vía Injecció de dependències: Als teus controlladors, helpers, model:

use Ajtarragona\TID\Services\TIDService;
...

public  function  test(TIDService  $client){
    $usuari=$client->getUser();
    ...
}

Vía funció helper:

...
public  function  test(){
    $usuari=tid()->getUser();
    ...
}

Tenim disponibles els següents mètodes:

  • getUser() retorna la informació de l'usuari
  • getToken() retorna el token de l'usuari
  • getAuth() retorna tota la informació d'autenticació (suari i informació del token)
ajtarragona

Author

ajtarragona