https://github.com/snoeren-development/laravel-admin-users

Define and check for admin users in your application!
https://github.com/snoeren-development/laravel-admin-users

admin laravel laravel-package middleware php

Last synced: 7 days ago
JSON representation

Define and check for admin users in your application!

• Host: GitHub
• URL: https://github.com/snoeren-development/laravel-admin-users
• Owner: snoeren-development
• License: mit
• Created: 2021-02-16T17:02:11.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T07:30:46.000Z (9 months ago)
• Last Synced: 2024-05-01T09:47:17.914Z (8 months ago)
• Topics: admin, laravel, laravel-package, middleware, php
• Language: PHP
• Homepage:
• Size: 190 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Admin Users

[![Latest version on Packagist](https://img.shields.io/packagist/v/snoeren-development/laravel-admin-users.svg?style=flat-square)](https://packagist.org/packages/snoeren-development/laravel-admin-users)

[![Software License](https://img.shields.io/github/license/snoeren-development/laravel-admin-users?style=flat-square)](LICENSE)

[![Build status](https://img.shields.io/github/actions/workflow/status/snoeren-development/laravel-admin-users/php.yml?branch=main&style=flat-square)](https://github.com/snoeren-development/laravel-admin-users/actions)

[![Downloads](https://img.shields.io/packagist/dt/snoeren-development/laravel-admin-users?style=flat-square)](https://packagist.org/packages/snoeren-development/laravel-admin-users)

This small package adds a configuration and user model trait to define

administrators within your application.

## Installation

Install the package using Composer:

```bash

composer require snoeren-development/laravel-admin-users

```

### Requirements

This package requires at least PHP 8.2 and Laravel 10.

## Usage

Add the `SnoerenDevelopment\AdminUsers\Adminable` trait to your user model and

define administrator users using the `ADMINS=` environment variable. The variable

should contain a comma separated list of email addresses of your application

administrators.

### Using the middleware

This package comes with middleware. This middleware checks if the user is an

administrator. If not, the middleware throws a 401 unauthorised exception.

Add the middleware to your `$routeMiddleware` list in the HTTP kernel to use.

```php

// Kernel.php

'admin' => \SnoerenDevelopment\AdminUsers\AdminMiddleware::class,

```

### Grant administrators all permissions

```php

// AuthServiceProvider.php

use Illuminate\Support\Facades\Gate;

public function boot()

{

    $this->registerPolicies();

    Gate::before(function ($user, $ability) {

        if ($user->isAdmin()) {

            return true;

        }

    });

}

```

### Using the gate via Blade

```blade

{{-- Using the gate via the can-statement. --}}

@can('admin')

    The current user is an admin!

@else

    The current user is not an admin!

@endcan

{{-- Using the custom if-statement --}}

@admin

    The current user is an admin!

@else

    The current user is not an admin!

@endadmin

```

### Publishing the configuration file

You can publish the configuration file to your project using

`php artisan vendor:publish`. Then select the admin package.

### Using the MySQL driver

Publish and run the migration or manually add the `is_admin` column to your users

table. Set the driver to `mysql` in your `.env` file using `ADMINS_DRIVER=mysql`.

## Testing

```bash

composer test

```

## Credits

- [Michael Snoeren](https://github.com/MSnoeren)

- [All Contributors](https://github.com/snoeren-development/laravel-admin-users/graphs/contributors)

## License

The MIT license. See [LICENSE](LICENSE) for more information.