andrewslince / slim3-mustache-view

src/Mustache.php

<?php

/**
 * MIT License
 *
 * Copyright (c) 2016 Andrews Lince
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * copies of the Software, and to permit persons to whom the Software is
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace Slim\Views;

use Psr\Http\Message\ResponseInterface;
use InvalidArgumentException;

/**
 * A Mustache view class for Slim 3 Framework
 * @author    Andrews Lince <andrews.lince@gmail.com>
 * @version   1.0.5
 * @link      https://github.com/andrewslince/slim3-mustache-view
 * @package   Slim/Views
 * @copyright 2016 Andrews Lince
 */
class Mustache
{
    /**
     * Instance of Mustache Template Engine
     * @since 1.0.0
     * @var   Mustache_Engine
     */
    protected $templateEngine = null;

    /**
     * Constructor method
     * @author Andrews Lince <andrews.lince@gmail.com>
     * @since  1.0.0
     * @param  array $options
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(array $options = [])
    {
        $this->templateEngine = $this->getTemplateEngine($options);
    }

    /**
     * Render a mustache template
     * @author Andrews Lince <andrews.lince@gmail.com>
     * @since  1.0.0
     * @param  ResponseInterface $response
     * @param  string            $template
     * @param  array             $data
     * @return ResponseInterface
     */
    public function render(
        ResponseInterface $response,
        $template,
        array $data = []
    ) {

        // render output
        $response->getBody()->write(
            $this->templateEngine->render($template, $data)
        );

        return $response;
    }

    /**
     * Fetch a HTML script tag with the template content
     * @author Andrews Lince <andrews.lince@gmail.com>
     * @since  1.0.0
     * @param  string $template Template to fetch content
     * @param  string $options

Should the type for parameter $options not be array? Also, consider making the array more specific, something like array<String>, or String[].

     * - (array)   htmlAttributes => HTML attributes to print in script tag
     * - (boolean) minify         => returns the minified content
     * @throws InvalidArgumentException
     * @return string HTML script tag with the template content
     */
    public function getTemplateScriptTag($template, array $options = [])
    {
        // validate the template name
        if (!$template) {
            throw new InvalidArgumentException(
                'The template name must be informed to get your HTML script tag'
            );
        }

        // process attributes from HTML script tag
        if (!isset($options['htmlAttributes'])) {
            $options['htmlAttributes'] = [];
        } else if (!is_array($options['htmlAttributes'])) {
            throw new InvalidArgumentException(
                'The "htmlAttributes" option must be an array'
            );
        }
        $htmlAttributes = $this->processHtmlAttributes(
            $options['htmlAttributes']
        );

        // process template content
        $templateContent = $this->templateEngine->getLoader()->load($template);
        if (isset($options['minify']) && $options['minify']) {
            $templateContent = $this->htmlMinify($templateContent);
        }

        return "<script $htmlAttributes>$templateContent</script>";

As per coding-style, please use concatenation or sprintf for the variable $htmlAttributes instead of interpolation.

As per coding-style, please use concatenation or sprintf for the variable $templateContent instead of interpolation.

    }

    /**
     * Returns the instance from Mustache Template Engine
     * @author Andrews Lince <andrews.lince@gmail.com>
     * @since  1.0.0
     * @param  array $options
     * - template
     *   - extension
     *   - charset
     *   - paths[]
     * @throws InvalidArgumentException
     * @return Mustache_Engine
     */
    private function getTemplateEngine(array $options = [])
    {
        if (is_null($this->templateEngine)) {

            if (!isset($options['template']['paths'])) {
                throw new InvalidArgumentException(
                    'Template paths was not informed'
                );
            }

            if (!is_array($options['template']['paths'])) {
                throw new InvalidArgumentException(
                    'Template paths must be an array'
                );
            }

            $loaders = [];
            foreach ($options['template']['paths'] as $templatePath) {
                $loaders[] = new \Mustache_Loader_FilesystemLoader(
                    $templatePath,
                    $options['template']
                );
            }

            // defines the mustache loaders
            $options['loader'] = new \Mustache_Loader_CascadingLoader($loaders);

            $this->templateEngine = new \Mustache_Engine($options);

It seems like new \Mustache_Engine($options) of type object<Mustache_Engine> is incompatible with the declared type object<Slim\Views\Mustache_Engine> of property $templateEngine.

        }

        return $this->templateEngine;

The expression $this->templateEngine; of type Mustache_Engine|Slim\Views\Mustache_Engine adds the type Mustache_Engine to the return on line 167 which is incompatible with the return type documented by Slim\Views\Mustache::getTemplateEngine of type Slim\Views\Mustache_Engine.

    }

    /**
     * Process the attributes to HTML script tag from template
     * @author Andrews Lince <andrews.lince@gmail.com>
     * @since  1.0.0
     * @param  array $options
     * - htmlAttributes
     * @return string
     */
    private function processHtmlAttributes(array $options = [])
    {
        $htmlAttributes = '';

        // default attributes
        $attributes = array('type' => 'x-tmpl-mustache');

        // check if exists custom attributes
        if (!empty($options)) {
            $attributes = array_merge($attributes, $options);
        }

        // compose the string with all HTML attributes
        foreach ($attributes as $key => $value) {
            $htmlAttributes .= " $key=\"$value\"";

As per coding-style, please use concatenation or sprintf for the variable $key instead of interpolation.

As per coding-style, please use concatenation or sprintf for the variable $value instead of interpolation.

        }

        return ltrim($htmlAttributes);
    }

    /**
     * Minify a HTML content
     * @author Andrews Lince <andrews.lince@gmail.com>
     * @since  1.0.0
     * @link   https://github.com/HossamYousef/slim3-minify/blob/master/src/Slim/Middleware/Minify.php
     * @param  string $content
     * @return string
     */
    private function htmlMinify($content)
    {
        $search = array(

            /**
             * remove tabs before and after HTML tags
             */
            '/\>[^\S ]+/s',
            '/[^\S ]+\</s',

            /**
             * remove empty lines (between HTML tags); cannot remove just
             * any line-end characters because in inline JS they can matter!
             */
            '/\>[\r\n\t ]+\</s',

            /**
             * shorten multiple whitespace sequences
             */
            '/(\s)+/s',

            /**
             * replace end of line by a space
             */
            '/\n/',

            /**
             * remove any HTML comments, except MSIE conditional comments
             */
            '/<!--(?!\s*(?:\[if [^\]]+]|<!|>))(?:(?!-->).)*-->/s',
        );

        $replace = array(
            '>',
            '<',
            '><',
            '\\1',
            ' ',
            ''
        );

        return preg_replace($search, $replace, $content);
    }
}

As per coding style, files should not end with a newline character.