raid / core-gate
Raid Core Gate Package
Requires
- php: ^8.2
- raid/core-command: *
This package is auto-updated.
Last update: 2025-03-28 01:45:50 UTC
README
This package is responsible for handling all gates in the system.
Installation
composer require raid/core-gate
Configuration
php artisan core:publish-gate
Usage
class PostController extends Controller { /** * Invoke the controller method. */ public function __invoke(Post $post) { Post::gates('show', $post); // or using the authorize method. Post::gates()->authorize('show', $post); return response()->json([ 'resource' => $post, ]); } }
How to work this
Let's start with our gateable class ex:Post
model.
<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Raid\Core\Gate\Traits\Gate\Gateable; class Post extends Model { use Gateable; }
The gateable class must use Gateable
trait.
To define our gates, we have two ways.
But remember if getGates
method is defined, the config/gate.php
gates will be ignored for this gateable class.
- Denfine
getGates
method in the gateable class, and define the gateable itself inconfig/gate.php
gateables.
<?php namespace App\Models; use App\Http\Gates\PostGate; use Illuminate\Database\Eloquent\Model; use Raid\Core\Gate\Traits\Gate\Gateable; class Post extends Model { use Gateable; /** * Get gateable gates. */ public static function getGates(): array { return [ // here we define our gate classes. PostGate::class, ]; } }
in config/gate.php
gateables.
'gateables' => [ // here we define our gateable class. Post::class, ],
- or define gateable with gates in
config/gate.php
gates.
'gates' => [ // here we define our gateable class. Post::class => [ // here we define our gate classes. PostGate::class, ], ],
Gate
Now, let's create our gate class PostGate
.
you can use this command to create the gate class.
php artisan core:make-gate PostGate
<?php namespace App\Http\Gates; use Raid\Core\Gate\Gates\Contracts\GateInterface; use Raid\Core\Gate\Gates\Gate; class PostGate extends Gate implements GateInterface { /** * {@inheritdoc} */ public const ACTIONS = []; }
The gate class must implement GateInterface
interface.
The gate class must extend Gate
class.
The gate class must define ACTIONS
constant, which is the gate methods that will be defined with the Illuminate\Support\Facades\Gate
class.
Let's define our gate first method.
<?php namespace App\Http\Gates; use App\Models\Post; use App\Models\User; use Raid\Core\Gate\Gates\Contracts\GateInterface; use Raid\Core\Gate\Gates\Gate; class PostGate extends Gate implements GateInterface { /** * {@inheritdoc} */ public const ACTIONS = [ 'show', ]; /** * Determine if the user can show the post. */ public function show(User $user, Post $post): bool { return $post->isPublic() || $user->isAdmin() || $user->isAuthor($post); } }
Great, now we can use the show
method/action in the PostController
.
<?php namespace App\Http\Controllers; use App\Models\Post; class PostController extends Controller { /** * Invoke the controller method. */ public function __invoke(Post $post) { Post::gates()->authorize('show', $post); return response()->json([ 'resource' => $post, ]); } }
The gates
method is a static method that will be called from the gateable
trait.
The authorize
method is a method that will lead to call Illuminate\Support\Facades\Gate
class authorize method.
The authorize
method will throw Illuminate\Auth\Access\AuthorizationException
exception if the gate method returns false
.
The authorize
method will return based on defined actions in the related gate class.
You can use the Illuminate\Support\Facades\Gate
to authorize gateable actions like this:
<?php namespace App\Http\Controllers; use App\Models\Post; class PostController extends Controller { /** * Invoke the controller method. */ public function __invoke(Post $post) { Gate::authorize('post.show', $post); return response()->json([ 'resource' => $post, ]); } }
We can override the gateable class name by defining gateableName
method in our class.
<?php namespace App\Models; use App\Http\Gates\PostGate; use Illuminate\Database\Eloquent\Model; use Raid\Core\Gate\Traits\Gate\Gateable; class Post extends Model { use Gateable; /** * Get gateable name. */ public static function gateableName(): string { return 'post'; } }
And that's it.
License
The MIT License (MIT). Please see License File for more information.
Credits
Security
If you discover any security-related issues, please email instead of using the issue tracker.
About Raid
Raid is a PHP framework created by Mohamed Khedr and it is maintained by Mohamed Khedr.
Support Raid
Raid is an MIT-licensed open-source project. It's an independent project with its ongoing development made possible.