Add PHP7.1+ type-hints

Author: akrabat

src/PhpRenderer.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Slim Framework (http://slimframework.com)
  *
@@ -34,14 +37,7 @@ class PhpRenderer
      */
     protected $layout;
 
-    /**
-     * SlimRenderer constructor.
-     *
-     * @param string $templatePath
-     * @param array $attributes
-     * @param string $layout
-     */
-    public function __construct($templatePath = "", $attributes = [], $layout = "")
+    public function __construct(string $templatePath = "", array $attributes = [], string $layout = "")
     {
         $this->templatePath = rtrim($templatePath, '/\\') . '/';
         $this->attributes = $attributes;
@@ -51,20 +47,12 @@ public function __construct($templatePath = "", $attributes = [], $layout = "")
     /**
      * Render a template
      *
-     * $data cannot contain template as a key
-     *
-     * throws RuntimeException if $templatePath . $template does not exist
-     *
-     * @param ResponseInterface $response
-     * @param string             $template
-     * @param array              $data
-     *
-     * @return ResponseInterface
+     * @note $data cannot contain template as a key
      *
      * @throws \InvalidArgumentException
-     * @throws \RuntimeException
+     * @throws \RuntimeException if $templatePath . $template does not exist
      */
-    public function render(ResponseInterface $response, $template, array $data = [])
+    public function render(ResponseInterface $response, string $template, array $data = []): ResponseInterface
     {
         $output = $this->fetch($template, $data, true);
 
@@ -75,20 +63,16 @@ public function render(ResponseInterface $response, $template, array $data = [])
 
     /**
      * Get layout template
-     *
-     * @return string
      */
-    public function getLayout()
+    public function getLayout(): string
     {
         return $this->layout;
     }
 
     /**
      * Set layout template
-     *
-     * @param string $layout
      */
-    public function setLayout($layout)
+    public function setLayout(string $layout): void
     {
         if ($layout === "" || $layout === null) {
             $this->layout = null;
@@ -103,18 +87,14 @@ public function setLayout($layout)
 
     /**
      * Get the attributes for the renderer
-     *
-     * @return array
      */
-    public function getAttributes()
+    public function getAttributes(): array
     {
         return $this->attributes;
     }
 
     /**
      * Set the attributes for the renderer
-     *
-     * @param array $attributes
      */
     public function setAttributes(array $attributes)
     {
@@ -123,21 +103,19 @@ public function setAttributes(array $attributes)
 
     /**
      * Add an attribute
-     *
-     * @param $key
-     * @param $value
      */
-    public function addAttribute($key, $value) {
+    public function addAttribute(string $key, $value): void
+    {
         $this->attributes[$key] = $value;
     }
 
     /**
      * Retrieve an attribute
      *
-     * @param $key
      * @return mixed
      */
-    public function getAttribute($key) {
+    public function getAttribute(string $key)
+    {
         if (!isset($this->attributes[$key])) {
             return false;
         }
@@ -147,42 +125,30 @@ public function getAttribute($key) {
 
     /**
      * Get the template path
-     *
-     * @return string
      */
-    public function getTemplatePath()
+    public function getTemplatePath(): string
     {
         return $this->templatePath;
     }
 
     /**
      * Set the template path
-     *
-     * @param string $templatePath
      */
-    public function setTemplatePath($templatePath)
+    public function setTemplatePath(string $templatePath): void
     {
         $this->templatePath = rtrim($templatePath, '/\\') . '/';
     }
 
     /**
      * Renders a template and returns the result as a string
      *
-     * cannot contain template as a key
-     *
-     * throws RuntimeException if $templatePath . $template does not exist
-     *
-     * @param $template
-     * @param array $data
-     * @param bool $useLayout
-     *
-     * @return mixed
+     * @note $data cannot contain template as a key
      *
      * @throws \InvalidArgumentException
      * @throws \RuntimeException
      */
-    public function fetch($template, array $data = [], $useLayout = false) {
-
+    public function fetch(string $template, array $data = [], bool $useLayout = false): string
+    {
         $output = $this->fetchTemplate($template, $data);
 
         if ($this->layout !== null && $useLayout) {
@@ -196,19 +162,13 @@ public function fetch($template, array $data = [], $useLayout = false) {
     /**
      * Renders a template and returns the result as a string
      *
-     * cannot contain template as a key
-     *
-     * throws RuntimeException if $templatePath . $template does not exist
-     *
-     * @param $template
-     * @param array $data
-     *
-     * @return mixed
+     * @note $data cannot contain template as a key
      *
      * @throws \InvalidArgumentException
      * @throws \RuntimeException
      */
-    public function fetchTemplate($template, array $data = []) {
+    public function fetchTemplate(string $template, array $data = []): string
+    {
         if (isset($data['template'])) {
             throw new \InvalidArgumentException("Duplicate template key found");
         }
@@ -223,7 +183,6 @@ public function fetchTemplate($template, array $data = []) {
             ob_start();
             $this->protectedIncludeScope($this->templatePath . $template, $data);
             $output = ob_get_clean();
-
         } catch(\Throwable $e) { // PHP 7+
             ob_end_clean();
             throw $e;
@@ -236,10 +195,10 @@ public function fetchTemplate($template, array $data = []) {
     }
 
     /**
-     * @param string $template
-     * @param array $data
+     * Include template within a separate scope for extracted $data
      */
-    protected function protectedIncludeScope ($template, array $data) {
+    protected function protectedIncludeScope (string $template, array $data): void
+    {
         extract($data);
         include func_get_arg(0);
     }

tests/PhpRendererTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use PHPUnit\Framework\TestCase;
 use Slim\Psr7\Headers;
 use Slim\Psr7\Response;
@@ -156,7 +158,7 @@ public function testExceptionInLayout() {
             $newResponse = $renderer->render($response, "template.phtml");
         } catch (Throwable $t) { // PHP 7+
             // Simulates an error template
-            $renderer->setLayout(null);
+            $renderer->setLayout('');
             $newResponse = $renderer->render($response, "template.phtml", [
                 "hello" => "Hi"
             ]);