लारवेल में उन्नत संसाधन प्राधिकरण प्रणाली। भाग 1. मॉडल, नियंत्रक

परिचय

हैलो, प्रिय खाबरोवचन।
एपीआई प्लेटफॉर्म पर अपने काम के दौरान, मैंने उपयोगकर्ता कार्यों को अधिकृत करने के लिए सही तरीके की तलाश में बहुत समय बिताया। कार्य निम्नानुसार सेट किया गया था - पहुंच नियंत्रण और कार्यों की एक काफी व्यापक प्रणाली बनाने के लिए।
इसी समय, उनमें से ज्यादातर एक नियमित सीआरयूडी पर हैं, लेकिन अन्य नियंत्रक कार्यों को अधिकृत करने की आवश्यकता होगी।
इसलिए एक सरल और एक ही समय में प्रभावी और लचीली प्रणाली बनाना आवश्यक है। बहुत सारे शंकु थे, क्योंकि इन लेखों में मैंने जो कुछ किया उसका कुछ हद तक सरलीकृत संस्करण प्रदर्शित करने का निर्णय लिया।

मैं अलग से जोड़ना चाहूंगा - सामग्री प्रोग्रामर के अभ्यास के लिए डिज़ाइन की गई है, और एक शुरुआत के लिए समझना मुश्किल होगा। यह आलेख प्रोजेक्ट की स्थापना और डेटाबेस से कनेक्ट करने के लिए सेटिंग्स को शेड्यूल नहीं करेगा। यह सब आप आसानी से इंटरनेट पर पा सकते हैं।

भाग 1. मॉडल, नियंत्रक

तो, कार्य: कई मॉडल हैं, जिनमें से संख्या परियोजना के विकास के दौरान बढ़ और घट सकती है।
उनमें से प्रत्येक पर कार्रवाई को भूमिकाओं द्वारा अधिकृत किया जाना चाहिए।
CRUD, और अतिरिक्त वाले (उदाहरण के लिए, आयात, निर्यात ) जैसी सरल क्रियाएं हैं ।
डेवलपर के काम (अपने प्रिय के लिए) को सरल बनाने के लिए आवश्यक है जितना संभव हो उतना अतिरिक्त मॉडल और विधियों को पेश करना।
लेख एक एपीआई आवेदन के लिए एक उदाहरण प्रदान करता है, लेकिन समाधान न केवल इसके लिए उपयुक्त है।

नमूना

Post. ( ) app.
app/Models Posts. ( , -).
. :

    php artisan make:model Models/Post --api --migration
    php artisan migrate

: , . , .

PostController CRUD
Controller.
ModelController Controller , , PostController.
PostController — import() export(Post $post).
, .

Laravel Illuminate\Foundation\Auth\Access\AuthorizesRequests.
App\Http\Controllers\Controller ModelController. Controller , .
authorizeResource($model).
, (Middleware) .
:

    can:viewAny,App\Models\Post
    can:view,post
    can:update,post

, , — :

1. viewAny view apiResource
2. , — .

:

. resourceAbilityMap() .

<?php
protected function resourceAbilityMap()
{
    return [
        'index' => 'viewAny',
        'show' => 'view',
        'create' => 'create',
        'store' => 'create',
        'edit' => 'update',
        'update' => 'update',
        'destroy' => 'delete',
    ];
}

. Laravel . , . index() , show(Post $post) . resourceMethodsWithoutModels()

<?php
protected function resourceMethodsWithoutModels()
{
    return ['index', 'create', 'store'];
}

(ModelController)

app/Http/Controllers ModelController. :

• $guardedMethods « » => « ».
  (Policy) , , (Gate). .
  
• $methodsWithoutModels .
  
• getModelClass() .
  .
  
• authorizeResource($this->getModelClass()) . ( (Route), )
  
• resourceAbilityMap() resourceMethodsWithoutModels() , , .
  

<?php

namespace App\Http\Controllers;

abstract class ModelController extends Controller
{
    /** @var array 'method' => 'policy'*/
    protected $guardedMethods = [];

    protected $methodsWithoutModels = [];

    protected abstract function getModelClass(): string;

    public function __construct()
    {
        $this->authorizeResource($this->getModelClass());
    }

    protected function resourceAbilityMap()
    {
        $base = parent::resourceAbilityMap();

        return array_merge($base, $this->guardedMethods);
    }

    protected function resourceMethodsWithoutModels()
    {
        $base = parent::resourceMethodsWithoutModels();

        return array_merge($base, $this->methodsWithoutModels);
    }
}

(PostController)

:

• getModelClass() .
• $methodsWithoutModels « » => « » . . , =. , , .
• $methodsWithoutModels , . import
• — , . — .

<?php

namespace App\Http\Controllers;

use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends ModelController
{
    /** @var array 'method' => 'policy'*/
    protected $guardedMethods = [
        'export' => 'export',
        'import' => 'import',
    ];

    protected $methodsWithoutModels = ['import'];

    protected function getModelClass(): string
    {
        return Post::class;
    }

    public function index()
    { /**     */ }

    public function store(Request $request)
    { /**    */ }

    public function show(Post $post)
    { /**    */ }

    public function update(Request $request, Post $post)
    { /**    */ }

    public function destroy(Post $post)
    { /**    */ }

    public function import()
    { /**     */ }

    public function export(Post $post)
    { /**    */ }
}

(Routes)

.
'routes/api.php' ( 'routes/web.php', ) .
, , .
— ( ) , Route::apiResource('posts', 'PostController'). Laravel. .
— 'auth:api'. , .

<?php

use App\Http\Controllers\PostController;
use Illuminate\Support\Facades\Route;

Route::group(['middleware' => ['auth:api']], static function () {
    Route::post('posts/import', 'PostController@import')->name('posts.import');
    Route::get('posts/{post}/export', 'PostController@export')->name('posts.export');
    Route::apiResource('posts', 'PostController');
});

. :

php artisan route:list

— ( )

+-----------------------+---------------------------+-------------------------------+
|URI                    |Action                     |Middleware                     |
+-----------------------+---------------------------+-------------------------------+
|api/posts              |...\PostController@index   |...,can:viewAny,App\Models\Post|
|api/posts              |...\PostController@store   |...,can:create,App\Models\Post |
|api/posts/import       |...\PostController@import  |...,can:import,App\Models\Post |
|api/posts/{post}       |...\PostController@show    |...,can:view,post              |
|api/posts/{post}       |...\PostController@update  |...,can:update,post            |
| एपीआई / पोस्ट / {पोस्ट} | ... \ पोस्टकंट्रोलर @ नष्ट | ...,: हटा सकते हैं, पोस्ट |
| एपीआई / पोस्ट / {पोस्ट} / निर्यात | ... \ पोस्टकंट्रोलर @ निर्यात | ..., कर सकते हैं: निर्यात, पोस्ट
+ ----------------------- + ------------------------- - + ------------------------------- +

अगला चरण लिंक गेट (गेट) <-> नीति को कॉन्फ़िगर करना है। लेकिन इसके बारे में दूसरे भाग में अधिक ।