Added ability to define attributes on the route. These will be overwr…

…itten by any matching route arguments.
slimphp · Jul 10, 2015 · 87d29d7 · 87d29d7
1 parent 50de533
commit 87d29d7
Show file tree

Hide file tree

Showing 5 changed files with 197 additions and 0 deletions.
diff --git a/Slim/Interfaces/RouteInterface.php b/Slim/Interfaces/RouteInterface.php
@@ -20,6 +20,13 @@
  */
 interface RouteInterface
 {
+    /**
+     * Get route attributes
+     *
+     * @return array
+     */
+    public function getAttributes();
+
     /**
      * Get route name
      *
@@ -34,6 +41,23 @@ public function getName();
      */
     public function getPattern();
 
+    /**
+     * Set a route attribute
+     *
+     * @param string $name
+     * @param string $value
+     * @return static
+     */
+    public function setAttribute($name, $value);
+
+    /**
+     * Set route attributes
+     *
+     * @param array $attributes
+     * @return static
+     */
+    public function setAttributes(array $attributes);
+
     /**
      * Set route name
      *

diff --git a/Slim/Route.php b/Slim/Route.php
@@ -35,6 +35,13 @@ class Route extends Routable implements RouteInterface
      */
     protected $methods = [];
 
+    /**
+     * Route default attributes
+     *
+     * @var array
+     */
+    protected $attributes = [];
+
     /**
      * Route name
      *
@@ -139,6 +146,16 @@ public function getGroups()
         return $this->groups;
     }
 
+    /**
+     * Get route attributes
+     *
+     * @return array
+     */
+    public function getAttributes()
+    {
+        return $this->attributes;
+    }
+
     /**
      * Get route name
      *
@@ -188,6 +205,33 @@ protected function setCallable(callable $callable)
         $this->callable = $callable;
     }
 
+    /**
+     * Set a route attribute
+     *
+     * @param string $name
+     * @param string $value
+     * @return $this
+     */
+    public function setAttribute($name, $value)
+    {
+        $this->attributes[$name] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set route attributes
+     *
+     * @param array $attributes
+     * @return $this
+     */
+    public function setAttributes(array $attributes)
+    {
+        $this->attributes = $attributes;
+
+        return $this;
+    }
+
     /**
      * Set route name
      *
@@ -205,6 +249,25 @@ public function setName($name)
         return $this;
     }
 
+    /**
+     * Add any attributes to the request that were not set earlier
+     *
+     * @param ServerRequestInterface $request
+     * @return ServerRequestInterface
+     */
+    protected function addAttributesToRequest(ServerRequestInterface $request)
+    {
+        // Get attributes to set
+        $attributes = array_diff_key($this->getAttributes(), $request->getAttributes());
+
+        // Add the attributes to the route
+        foreach ($attributes as $k => $v) {
+            $request = $request->withAttribute($k, $v);
+        }
+
+        return $request;
+    }
+
     /********************************************************************************
      * Route Runner
      *******************************************************************************/
@@ -223,6 +286,11 @@ public function setName($name)
      */
     public function run(ServerRequestInterface $request, ResponseInterface $response)
     {
+        // Set any Default Attributes on the request
+        if (0 !== count($this->getAttributes())) {
+            $request = $this->addAttributesToRequest($request);
+        }
+
         // Traverse middleware stack and fetch updated response
         return $this->callMiddlewareStack($request, $response);
     }

diff --git a/index.php b/index.php
@@ -31,6 +31,11 @@
     return $response;
 });
 
+$app->get('/hello/world', function ($request, $response, $args) {
+    $response->write("Hello " . $args['extra']);
+    return $response;
+})->setAttribute('extra', 'world');
+
 $app->get('/hello/{name}', function ($request, $response, $args) {
     $response->write("Hello, " . $args['name']);
     return $response;

diff --git a/tests/AppTest.php b/tests/AppTest.php
@@ -232,6 +232,61 @@ public function testInvokeWithMatchingRoute()
         $this->assertEquals('Hello', (string)$res->getBody());
     }
 
+    public function testInvokeWithMatchingRouteWithAttribute()
+    {
+        $app = new App();
+        $app->get('/foo/bar', function ($req, $res, $args) {
+            return $res->write("Hello {$args['attribute']}");
+        })->setAttribute('attribute', 'world!');
+
+        // Prepare request and response objects
+        $env = Environment::mock([
+            'SCRIPT_NAME' => '/index.php',
+            'REQUEST_URI' => '/foo/bar',
+            'REQUEST_METHOD' => 'GET',
+        ]);
+        $uri = Uri::createFromEnvironment($env);
+        $headers = Headers::createFromEnvironment($env);
+        $cookies = [];
+        $serverParams = $env->all();
+        $body = new Body(fopen('php://temp', 'r+'));
+        $req = new Request('GET', $uri, $headers, $cookies, $serverParams, $body);
+        $res = new Response();
+
+        // Invoke app
+        $resOut = $app($req, $res);
+
+        $this->assertInstanceOf('\Psr\Http\Message\ResponseInterface', $resOut);
+        $this->assertEquals('Hello world!', (string)$res->getBody());
+    }
+
+    public function testInvokeWithMatchingRouteWithAttributes()
+    {
+        $app = new App();
+        $app->get('/foo/bar', function ($req, $res, $args) {
+            return $res->write("Hello {$args['attribute1']} {$args['attribute2']}");
+        })->setAttributes(['attribute1' => 'there', 'attribute2' => 'world!']);
+
+        // Prepare request and response objects
+        $env = Environment::mock([
+            'SCRIPT_NAME' => '/index.php',
+            'REQUEST_URI' => '/foo/bar',
+            'REQUEST_METHOD' => 'GET',
+        ]);
+        $uri = Uri::createFromEnvironment($env);
+        $headers = Headers::createFromEnvironment($env);
+        $cookies = [];
+        $serverParams = $env->all();
+        $body = new Body(fopen('php://temp', 'r+'));
+        $req = new Request('GET', $uri, $headers, $cookies, $serverParams, $body);
+        $res = new Response();
+
+        // Invoke app
+        $resOut = $app($req, $res);
+
+        $this->assertInstanceOf('\Psr\Http\Message\ResponseInterface', $resOut);
+        $this->assertEquals('Hello there world!', (string)$res->getBody());
+    }
 
     public function testInvokeWithMatchingRouteWithNamedParameter()
     {
@@ -294,6 +349,34 @@ public function testInvokeWithMatchingRouteWithNamedParameterRequestResponseArgS
         $this->assertEquals('Hello test!', (string)$res->getBody());
     }
 
+    public function testInvokeWithMatchingRouteWithNamedParameterOverwritesAttribute()
+    {
+        $app = new App();
+        $app->get('/foo/{name}', function ($req, $res, $args) {
+            return $res->write("Hello {$args['extra']} {$args['name']}");
+        })->setAttributes(['extra' => 'there', 'name' => 'world!']);
+
+        // Prepare request and response objects
+        $env = Environment::mock([
+            'SCRIPT_NAME' => '/index.php',
+            'REQUEST_URI' => '/foo/test!',
+            'REQUEST_METHOD' => 'GET',
+        ]);
+        $uri = Uri::createFromEnvironment($env);
+        $headers = Headers::createFromEnvironment($env);
+        $cookies = [];
+        $serverParams = $env->all();
+        $body = new Body(fopen('php://temp', 'r+'));
+        $req = new Request('GET', $uri, $headers, $cookies, $serverParams, $body);
+        $res = new Response();
+
+        // Invoke app
+        $resOut = $app($req, $res);
+
+        $this->assertInstanceOf('\Psr\Http\Message\ResponseInterface', $resOut);
+        $this->assertEquals('Hello there test!', (string)$res->getBody());
+    }
+
     public function testInvokeWithoutMatchingRoute()
     {
         $app = new App();

diff --git a/tests/RouteTest.php b/tests/RouteTest.php
@@ -116,6 +116,23 @@ public function testAddMiddleware()
         $this->assertCount(2, $prop->getValue($route));
     }
 
+    public function testSetAttribute()
+    {
+        $route = $this->routeFactory();
+        $this->assertEquals($route, $route->setAttribute('attribute', 'value'));
+        $this->assertEquals(['attribute' => 'value'], $route->getAttributes());
+        $this->assertEquals($route, $route->setAttribute('attribute', 'value2'));
+        $this->assertEquals($route, $route->setAttribute('attribute2', 'value3'));
+        $this->assertEquals(['attribute' => 'value2', 'attribute2' => 'value3'], $route->getAttributes());
+    }
+
+    public function testSetAttributes()
+    {
+        $route = $this->routeFactory();
+        $this->assertEquals($route, $route->setAttributes(['attribute' => 'value']));
+        $this->assertEquals(['attribute' => 'value'], $route->getAttributes());
+    }
+
     public function testSetName()
     {
         $route = $this->routeFactory();