├── .gitignore
├── LICENSE.md
├── README.md
├── composer.json
├── phpunit.xml
├── src
    ├── Attribute
    │   ├── ClassMiddleware.php
    │   └── Middleware.php
    ├── AttributeMiddleware.php
    └── BaseController.php
└── tests
    └── Middleware
        ├── Fixture
            └── FooController.php
        └── MiddlewareTest.php


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | vendor
3 | .phpunit.cache
4 | composer.lock
5 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022 Saeed-Pooyanfar
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel #[Annotation]
 2 | 
 3 | ### Introduction
 4 | 
 5 | PHP 8.0 release was a revolution for the language.  
 6 | It brings cool features like [`Named arguments`](https://www.php.net/releases/8.0/en.php#named-arguments), [`Attributes`](https://www.php.net/releases/8.0/en.php#attributes), [`Constructor property`](https://www.php.net/releases/8.0/en.php#constructor-property-promotion) and ...  
 7 | PHP 8.1 brings even more exciting features like [`Enumerations`](https://www.php.net/releases/8.1/en.php#enumerations), [`New in initializers`](https://www.php.net/releases/8.1/en.php#new_in_initializers), [`Array unpacking`](https://www.php.net/releases/8.1/en.php#array_unpacking_support_for_string_keyed_arrays) and ...  
 8 | **The idea of this package is using PHP [`Attribute`](https://www.php.net/manual/en/language.attributes.overview.php) in a laravel project.**
 9 | 
10 | ### Installing
11 | 
12 | ```bash
13 | composer require saeedpooyanfar/laravel-annotation
14 | ```
15 | 
16 | ### Setup
17 | 
18 | In `App\Http\Controllers\Controller::class` :  
19 | Replace `use Illuminate\Routing\Controller as BaseController;`  
20 | With `use LaravelAnnotation\BaseController;`
21 |   
22 | Or if you don't want to change your BaseController you can:  
23 |   
24 | Use `LaravelAnnotation\AttributeMiddleware` trait  
25 | In `App\Http\Controllers\Controller::class`
26 | 
27 | ### Middleware attribute
28 | 
29 | Here is an example that how you can use `Middleware` attribute in a laravel controller:
30 | 
31 | ```php
32 | <?php
33 | 
34 | use LaravelAnnotation\Attribute\Middleware;
35 | 
36 | #[Middleware(RedirectIfAuthenticated::class, 'sanctum', except: 'logout')]
37 | class AuthController extends Controller
38 | {
39 |     public function register()
40 |     {
41 |     }
42 |     
43 |     public function login()
44 |     {
45 |     }
46 |     
47 |     #[Middleware(Authenticate::class, 'sanctum')]
48 |     public function logout()
49 |     {
50 |     }
51 | }
52 | ```
53 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "saeedpooyanfar/laravel-annotation",
 3 |     "description": "Laravel #[Annotation]",
 4 |     "version": "5.0.0",
 5 |     "type": "library",
 6 |     "require": {
 7 |         "php": "^8.2"
 8 |     },
 9 |     "require-dev": {
10 |         "illuminate/routing": "^11.x-dev",
11 |         "illuminate/events": "^11.x-dev",
12 |         "phpunit/phpunit": "^10.5",
13 |         "mockery/mockery": "^1.6"
14 |     },
15 |     "license": "MIT",
16 |     "autoload": {
17 |         "psr-4": {
18 |             "LaravelAnnotation\\": "src/"
19 |         }
20 |     },
21 |     "autoload-dev": {
22 |         "psr-4": {
23 |             "Tests\\": "tests/"
24 |         }
25 |     },
26 |     "authors": [
27 |         {
28 |             "name": "SaeedPooyanfar",
29 |             "email": "saeedp47@gmail.com"
30 |         }
31 |     ],
32 |     "minimum-stability": "stable",
33 |     "prefer-stable": true
34 | }
35 | 


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
 4 |          colors="true"
 5 |          beStrictAboutTestsThatDoNotTestAnything="false"
 6 |          cacheDirectory=".phpunit.cache">
 7 |   <testsuites>
 8 |     <testsuite name="Package Test Suite">
 9 |       <directory>./tests</directory>
10 |     </testsuite>
11 |   </testsuites>
12 |   <php>
13 |     <ini name="date.timezone" value="UTC" />
14 |     <ini name="intl.default_locale" value="C.UTF-8" />
15 |     <ini name="memory_limit" value="2048M" />
16 |   </php>
17 | </phpunit>
18 | 


--------------------------------------------------------------------------------
/src/Attribute/ClassMiddleware.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace LaravelAnnotation\Attribute;
 4 | 
 5 | use Attribute;
 6 | 
 7 | /**
 8 |  * Basically #[Middleware] register middlewares for methods first
 9 |  * If you want to register middlewares for class before methods:
10 |  * Use #[ClassMiddleware]
11 |  */
12 | #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
13 | class ClassMiddleware extends Middleware
14 | {
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Attribute/Middleware.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace LaravelAnnotation\Attribute;
 4 | 
 5 | use Attribute;
 6 | 
 7 | #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 8 | class Middleware
 9 | {    
10 |     public array $options = [];
11 | 
12 |     /**
13 |      * @param string $name
14 |      * @param string|object|string[]|object[] $arguments
15 |      * @param string|string[] $only
16 |      * @param string|string[] $except
17 |      */
18 |     public function __construct(public string $name, public string | object | array $arguments = [], public string | array $only = [], public string | array $except = [])
19 |     {
20 |         //
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/src/AttributeMiddleware.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace LaravelAnnotation;
 4 | 
 5 | use BackedEnum;
 6 | use Illuminate\Routing\ControllerMiddlewareOptions;
 7 | use LaravelAnnotation\Attribute\ClassMiddleware;
 8 | use LaravelAnnotation\Attribute\Middleware;
 9 | use ReflectionAttribute;
10 | use ReflectionClass;
11 | 
12 | trait AttributeMiddleware
13 | {
14 |     /**
15 |      * Get the middleware assigned to the controller.
16 |      *
17 |      * @return array
18 |      */
19 |     public function getMiddleware(): array
20 |     {
21 |         $middlewares = (new ReflectionClass($this))->getAttributes("middleware");
22 |         return array_merge($middlewares, $this->getMiddlewaresByAttributes());
23 |     }
24 | 
25 |     /**
26 |      * Get the controller middlewares by attributes
27 |      *
28 |      * @see Middleware
29 |      *
30 |      * @return array
31 |      */
32 |     public function getMiddlewaresByAttributes(): array
33 |     {
34 |         $middlewares = [];
35 | 
36 |         /** @return string[] */
37 |         $filterArguments = function (array $arguments): array {
38 |             $items = [];
39 | 
40 |             foreach ($arguments as $argument) {
41 |                 if (is_string($argument) && $argument !== '') $items[] = $argument;
42 |                 if ($argument instanceof BackedEnum && $argument->value !== '') $items[] = (string) $argument->value;
43 |             }
44 | 
45 |             return $items;
46 |         };
47 | 
48 |         /** @var ReflectionAttribute[] $attributes */
49 |         $push = function (array $attributes, ?string $method = null) use (&$middlewares, $filterArguments) {
50 |             foreach ($attributes as $attribute) {
51 |                 /** @var Middleware $middleware */
52 |                 $middleware = $attribute->newInstance();
53 |                 $arguments = [];
54 | 
55 |                 if (!is_array($middleware->arguments)) {
56 |                     $middleware->arguments = [$middleware->arguments];
57 |                 }
58 | 
59 |                 foreach ($middleware->arguments as $argument) {
60 |                     $items = $filterArguments(is_array($argument) ? $argument : [$argument]);
61 |                     if ($items) {
62 |                         $arguments[] = implode('|', $items);
63 |                     }
64 |                 }
65 | 
66 |                 $name = $middleware->name;
67 |                 if ($arguments) $name .= ':'.implode(',', $arguments);
68 | 
69 |                 $middlewares[] = [
70 |                     'middleware' => $name,
71 |                     'options' => &$middleware->options
72 |                 ];
73 | 
74 |                 $middlewareOptions = new ControllerMiddlewareOptions($middleware->options);
75 | 
76 |                 if ($method) $middlewareOptions->only((array) $method);
77 |                 elseif ($middleware->only) $middlewareOptions->only((array) $middleware->only);
78 |                 elseif ($middleware->except) $middlewareOptions->except((array) $middleware->except);
79 |             }
80 |         };
81 | 
82 |         $class = new ReflectionClass($this);
83 | 
84 |         // ClassMiddleware (Higher priority, before methods)
85 |         $push($class->getAttributes(ClassMiddleware::class));
86 | 
87 |         // Methods
88 |         foreach ($class->getMethods() as $method) {
89 |             $push($method->getAttributes(Middleware::class), $method->name);
90 |         }
91 | 
92 |         // Class
93 |         $push($class->getAttributes(Middleware::class));
94 | 
95 |         return $middlewares;
96 |     }
97 | }
98 | 


--------------------------------------------------------------------------------
/src/BaseController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace LaravelAnnotation;
 4 | 
 5 | use Illuminate\Routing\Controller;
 6 | 
 7 | class BaseController extends Controller
 8 | {
 9 |     use AttributeMiddleware;
10 | }
11 | 


--------------------------------------------------------------------------------
/tests/Middleware/Fixture/FooController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests\Middleware\Fixture;
 4 | 
 5 | use Illuminate\Http\Request;
 6 | use LaravelAnnotation\Attribute\ClassMiddleware;
 7 | use LaravelAnnotation\Attribute\Middleware;
 8 | use LaravelAnnotation\BaseController;
 9 | 
10 | #[ClassMiddleware('first', only: 'update')]
11 | #[ClassMiddleware('second', except: ['index', 'destroy'])]
12 | #[Middleware('three', except: 'store')]
13 | #[Middleware('six', only: ['store', 'update'])]
14 | class FooController extends BaseController
15 | {
16 |     #[Middleware('one')]
17 |     #[Middleware('two', ['arg1', 'arg2'])]
18 |     public function index()
19 |     {
20 |     }
21 | 
22 |     #[Middleware('four')]
23 |     #[Middleware('five', 'arg')]
24 |     public function store(Request $request)
25 |     {
26 |     }
27 | 
28 |     public function update(Request $request, string $id)
29 |     {
30 |     }
31 | 
32 |     #[Middleware('multiple', ['arg1', ['arg2-1', 'arg2-2']])]
33 |     public function destroy(Request $request, string $id)
34 |     {
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/tests/Middleware/MiddlewareTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests\Middleware;
 4 | 
 5 | use Exception;
 6 | use Illuminate\Container\Container;
 7 | use Illuminate\Events\Dispatcher;
 8 | use Illuminate\Routing\Route;
 9 | use Illuminate\Routing\Router;
10 | use Mockery;
11 | use PHPUnit\Framework\TestCase;
12 | use Tests\Middleware\Fixture\FooController;
13 | 
14 | class MiddlewareTest extends TestCase
15 | {
16 |     public ?Router $router = null;
17 | 
18 |     public function setUp(): void
19 |     {
20 |         parent::setUp();
21 | 
22 |         try {
23 |             $this->router = new Router(Mockery::mock(Dispatcher::class), Container::getInstance());
24 |             $this->router->get('resource', [FooController::class, 'index']);
25 |             $this->router->post('resource', [FooController::class, 'store']);
26 |             $this->router->put('resource/{id}', [FooController::class, 'update']);
27 |             $this->router->delete('resource/{id}', [FooController::class, 'destroy'])->middleware('classic');
28 |         } catch (Exception) {
29 |         }
30 |     }
31 | 
32 |     public function testRouterInstance(): void
33 |     {
34 |         $this->assertNotNull($this->router);
35 |     }
36 | 
37 |     public function testIndexMiddleware(): void
38 |     {
39 |         $route = $this->getRoute('GET');
40 | 
41 |         $this->assertNotEquals(false, $route);
42 |         $this->assertEquals(['one', 'two:arg1,arg2', 'three'], $route->gatherMiddleware());
43 |     }
44 | 
45 |     public function testStoreMiddleware(): void
46 |     {
47 |         $route = $this->getRoute('POST');
48 | 
49 |         $this->assertNotEquals(false, $route);
50 |         $this->assertEquals(['second', 'four', 'five:arg', 'six'], $route->gatherMiddleware());
51 |     }
52 | 
53 |     public function testUpdateMiddleware(): void
54 |     {
55 |         $route = $this->getRoute('PUT');
56 | 
57 |         $this->assertNotEquals(false, $route);
58 |         $this->assertEquals(['first', 'second', 'three', 'six'], $route->gatherMiddleware());
59 |     }
60 | 
61 |     public function testDestroyMiddleware(): void
62 |     {
63 |         $route = $this->getRoute('DELETE');
64 | 
65 |         $this->assertNotEquals(false, $route);
66 |         $this->assertEquals(['classic', 'multiple:arg1,arg2-1|arg2-2', 'three'], $route->gatherMiddleware());
67 |     }
68 | 
69 |     public function getRoute(string $method): Route | bool
70 |     {
71 |         $routes = $this->router->getRoutes()->get($method);
72 |         return end($routes);
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------