Merge pull request #59 from slimphp/FixDocblocsLicenses

Fix docblocs and license information

Author: l0gicgate

phpcs.xml

@@ -8,10 +8,10 @@
     <arg name="colors"/>
 
     <!-- inherit rules from: -->
-    <rule ref="PSR12"/>
+    <rule ref="PSR2"/>
     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
 
     <!-- Paths to check -->
     <file>src</file>
     <file>tests</file>
-</ruleset>
+</ruleset>

src/Exception/PhpTemplateNotFoundException.php

@@ -1,4 +1,9 @@
 <?php
+/**
+ * Slim Framework (https://slimframework.com)
+ *
+ * @license https://github.com/slimphp/PHP-View/blob/3.x/LICENSE.md (MIT License)
+ */
 
 declare(strict_types=1);
 

src/PhpRenderer.php

@@ -1,44 +1,38 @@
 <?php
-
-declare(strict_types=1);
-
 /**
- * Slim Framework (http://slimframework.com)
+ * Slim Framework (https://slimframework.com)
  *
- * @link      https://github.com/slimphp/PHP-View
- * @copyright Copyright (c) 2011-2015 Josh Lockhart
- * @license   https://github.com/slimphp/PHP-View/blob/master/LICENSE.md (MIT License)
+ * @license https://github.com/slimphp/PHP-View/blob/3.x/LICENSE.md (MIT License)
  */
+
+declare(strict_types=1);
+
 namespace Slim\Views;
 
 use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 use Slim\Views\Exception\PhpTemplateNotFoundException;
 use Throwable;
 
-/**
- * Class PhpRenderer
- * @package Slim\Views
- *
- * Render PHP view scripts into a PSR-7 Response object
- */
 class PhpRenderer
 {
     /**
      * @var string
      */
     protected $templatePath;
-
-    /**
+/**
      * @var array
      */
     protected $attributes;
-
-    /**
+/**
      * @var string
      */
     protected $layout;
-
+/**
+     * @param string $templatePath
+     * @param array  $attributes
+     * @param string $layout
+     */
     public function __construct(string $templatePath = '', array $attributes = [], string $layout = '')
     {
         $this->templatePath = rtrim($templatePath, '/\\') . '/';
@@ -47,33 +41,31 @@ public function __construct(string $templatePath = '', array $attributes = [], s
     }
 
     /**
-     * Render a template
+     * @param ResponseInterface $response
+     * @param string            $template
+     * @param array             $data
      *
-     * @note $data cannot contain template as a key
+     * @return ResponseInterface
      *
-     * @throws InvalidArgumentException
-     * @throws PhpTemplateNotFoundException if $templatePath . $template does not exist
      * @throws Throwable
      */
     public function render(ResponseInterface $response, string $template, array $data = []): ResponseInterface
     {
         $output = $this->fetch($template, $data, true);
-
         $response->getBody()->write($output);
-
         return $response;
     }
 
     /**
-     * Get layout template
+     * @return string
      */
     public function getLayout(): string
     {
         return $this->layout;
     }
 
     /**
-     * Set layout template
+     * @param string $layout
      */
     public function setLayout(string $layout): void
     {
@@ -89,33 +81,38 @@ public function setLayout(string $layout): void
     }
 
     /**
-     * Get the attributes for the renderer
+     * @return array
      */
     public function getAttributes(): array
     {
         return $this->attributes;
     }
 
     /**
-     * Set the attributes for the renderer
+     * @param array $attributes
+     *
+     * @return void
      */
-    public function setAttributes(array $attributes)
+    public function setAttributes(array $attributes): void
     {
         $this->attributes = $attributes;
     }
 
     /**
-     * Add an attribute
+     * @param string $key
+     * @param        $value
+     *
+     * @return void
      */
     public function addAttribute(string $key, $value): void
     {
         $this->attributes[$key] = $value;
     }
 
     /**
-     * Retrieve an attribute
+     * @param string $key
      *
-     * @return mixed
+     * @return bool|mixed
      */
     public function getAttribute(string $key)
     {
@@ -127,34 +124,33 @@ public function getAttribute(string $key)
     }
 
     /**
-     * Get the template path
+     * @return string
      */
     public function getTemplatePath(): string
     {
         return $this->templatePath;
     }
 
     /**
-     * Set the template path
+     * @param string $templatePath
      */
     public function setTemplatePath(string $templatePath): void
     {
         $this->templatePath = rtrim($templatePath, '/\\') . '/';
     }
 
     /**
-     * Renders a template and returns the result as a string
+     * @param string $template
+     * @param array  $data
+     * @param bool   $useLayout
      *
-     * @note $data cannot contain template as a key
+     * @return string
      *
-     * @throws InvalidArgumentException
-     * @throws PhpTemplateNotFoundException
      * @throws Throwable
      */
     public function fetch(string $template, array $data = [], bool $useLayout = false): string
     {
         $output = $this->fetchTemplate($template, $data);
-
         if ($this->layout !== null && $useLayout) {
             $data['content'] = $output;
             $output = $this->fetchTemplate($this->layout, $data);
@@ -164,12 +160,11 @@ public function fetch(string $template, array $data = [], bool $useLayout = fals
     }
 
     /**
-     * Renders a template and returns the result as a string
+     * @param string $template
+     * @param array  $data
      *
-     * @note $data cannot contain template as a key
+     * @return string
      *
-     * @throws InvalidArgumentException
-     * @throws PhpTemplateNotFoundException
      * @throws Throwable
      */
     public function fetchTemplate(string $template, array $data = []): string
@@ -184,7 +179,6 @@ public function fetchTemplate(string $template, array $data = []): string
         }
 
         $data = array_merge($this->attributes, $data);
-
         try {
             ob_start();
             $this->protectedIncludeScope($this->templatePath . $template, $data);
@@ -198,7 +192,10 @@ public function fetchTemplate(string $template, array $data = []): string
     }
 
     /**
-     * Include template within a separate scope for extracted $data
+     * @param string $template
+     * @param array  $data
+     *
+     * @return void
      */
     protected function protectedIncludeScope(string $template, array $data): void
     {