Merge pull request #1 from php-api-clients/feature-priority

Priority

src/DefaultPriorityTrait.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Foundation\Middleware;
+
+trait DefaultPriorityTrait
+{
+    /**
+     * @return int
+     */
+    public function priority(): int
+    {
+        return 500;
+    }
+}

src/MiddlewareInterface.php

@@ -11,6 +11,14 @@
  */
 interface MiddlewareInterface
 {
+    /**
+     * Priority ranging from 0 to 1000. Where 1000 will be executed first on `pre` and 0 last on `pre`.
+     * For `post` the order is reversed.
+     *
+     * @return int
+     */
+    public function priority(): int;
+
     /**
      * Return the processed $request via a fulfilled promise.
      * When implementing cache or other feature that returns a response, do it with a rejected promise.

tests/DummyMiddleware.php

@@ -3,12 +3,14 @@
 
 namespace ApiClients\Tests\Foundation\Middleware;
 
+use ApiClients\Foundation\Middleware\DefaultPriorityTrait;
 use ApiClients\Foundation\Middleware\MiddlewareInterface;
 use ApiClients\Foundation\Middleware\PostTrait;
 use ApiClients\Foundation\Middleware\PreTrait;
 
 class DummyMiddleware implements MiddlewareInterface
 {
+    use DefaultPriorityTrait;
     use PreTrait;
     use PostTrait;
 }

tests/DummyMiddlewareTest.php

@@ -11,6 +11,15 @@
 
 class DummyMiddlewareTest extends TestCase
 {
+    public function testPriority()
+    {
+        $middleware = new DummyMiddleware();
+        $this->assertSame(
+            500,
+            $middleware->priority()
+        );
+    }
+
     public function testPre()
     {
         $middleware = new DummyMiddleware();