nextgen-tech/laravel-abilities

v0.2.0 2020-10-22 08:09 UTC

Requires

• php: ^5.6|^7.0
• illuminate/auth: ^5.4|^6.0|^7.0|^8.0
• illuminate/routing: ^5.4|^6.0|^7.0|^8.0
• illuminate/support: ^5.4|^6.0|^7.0|^8.0
• illuminate/translation: ^5.4|^6.0|^7.0|^8.0

Requires (Dev)

• phpstan/phpstan: ^0.12.50

MIT

• Krzysztof Grabania

README

Spis treści

• Instalacja
  • composer
  • Service Provider
  • Middleware
  • Kopiowanie plików
  • Migracje
• Konfiguracja
• Definicja uprawnień
  • Grupy uprawnień
  • Pojedyncze uprawnienie
    • Aliasy
    • Własna funkcja
  • Zasoby uprawnień
• Sprawdzanie uprawnień

Instalacja

composer

W terminalu wpisz

composer require nextgen-tech/laravel-abilities:^1.0

Service Provider

Jeśli aplikacja korzysta z Laravela w wersji 5.5 lub wyższej to możesz pominąć ten krok.

W pliku config/app.php do listy providerów dopisz:

'providers' => [
    ...
    NGT\Laravel\Abilities\AbilityServiceProvider::class
]

Middleware

W pliku app/Http/Kernel.php do grupy web należy dopisać:

protected $middlewareGroups = [
    'web' => [
        ...
        \NGT\Laravel\Abilities\Middleware\CheckUserAbilities::class
    ]
]

Kopiowanie plików

Aby skopiować z paczki niezbędne pliki wykonaj następujące polecenie:

php artisan vendor:publish --provider="NGT\\Laravel\\Abilities\\AbilityServiceProvider"

Można także opublikować część plików podając jeden z tagów: config, translations, models lub migrations:

php artisan vendor:publish --provider="NGT\\Laravel\\Abilities\\AbilityServiceProvider" --tag=config

Migracje

Uruchom migracje

php artisan migrate

Konfiguracja

Konfiguracja paczki znajduje się w pliku config/abilities.php.

return [
    'path'   => base_path('routes/abilities.php'), // Ścieżka do definicji uprawnień

    'models' => [
        'user'               => App\User::class, // Model użytkowników
        'user_ability'       => App\UserAbility::class, // Model uprawnień użytkowników 

        'user_group'         => App\UserGroup::class, // Model grup użytkowników
        'user_group_ability' => App\UserGroupAbility::class, // Model uprawnień grup użytkowników
    ],
];

Definicja uprawnień

Domyślnie uprawnienia znajdują się w pliku routes/abilities.php. Ścieżkę tę można zmienić w konfiguracji.

Definiować uprawnienia należy za pomocą fasady NGT\Laravel\Abilities\Facades\Ability lub instancji klasy NGT\Laravel\Abilities\AbilityRegistrar.

Grupy uprawnień

Ability::group(array $attributes, callable $abilities)

Grupy definiujemy za pomocą metody group. Grupa może składać się z wyświetlanej nazwy (label) oraz przedrostka (prefix), ale żadna z tych opcji nie jest obowiązkowa. Grupa może także zawierać w sobie inne grupy. Dane grupy są przekazywane do podrzędnych elementów znajdujących się w anonimowej funkcji.

Ability::group(['label' => 'Panel administracyjny', 'prefix' => 'admin'], function() {
    ...
})

Pojedyncze uprawnienie

Ability::define(string $slug, string $label, array $options = [])

Każde uprawnienie posiada swoją uproszczoną nazwe ($slug) oraz wyświetlaną nazwe ($label). Dodatkowo można zdefiniować opcje ($options).

Aliasy

Każde uprawnienie może posiadać aliasy. Najlepszym przykładem są akcje create-store oraz edit-update. Aby zarządzać nimi jako jednym uprawnieniem można je zdefiniować w następujący sposób:

Ability::define('create', 'Tworzenie', [
    'aliases' => ['store'],
]);

Własna funkcja

Aby uprawnienie nie korzystało z domyślnej metody weryfikacji można przekazać do niego funkcję. Funkcja ta zostanie wykonana zamiast domyślnej.

Ability::define('index', 'Wyświetlanie', [
    'callback' => function($user, $ability) {
        return $user->is_activated;
    }
])

Zasoby uprawnień

Ability::resource(string $prefix, string $label, array $options = [])

Podobnie jak w routingu, w uprawnieniach również można definiować zasoby. Podczas tworzenia zasobu należy podać przedrostek grupy ($prefix) oraz wyświetlaną nazwę grupy ($label).

Ability::resource('user', 'Użytkownicy');

Dodatkowo można przekazać opcje wykluczace lub dopuszczające tylko wybrane uprawnienia.

Ability::resource('user', 'Użytkownicy', [
    'only' => ['index', 'create', 'edit'],
]);

Ability::resource('user', 'Użytkownicy', [
    'except' => ['show', 'destroy'],
]);

Sprawdzanie uprawnień

Kaźde uprawnienie można sprawdzać za pomocą standardowych metod klasy Gate:

Gate::allows('admin.user.index');
@can('admin.user.index');
Route::get('/', 'UserController@index')->middleware('can:admin.user.index');

Aby kontroler automatycznie sprawdzał uprawnienia do danych akcji można zdefiniować w nim listę powiązań między akcjami a uprawnieniami

class UserController extends Controller
{
    ...
    
    public $actionAbilities = [
        'index'  => 'admin.user.index',
        'create' => 'admin.user.create',
    ];
    
    ...
}