drdim / yii2-pug

ViewRenderer.php

<?php
/**
 * View.php
 */

namespace drdim\yii\pug;

use Pug\Pug;
use Yii;
use yii\base\View;
use yii\helpers\FileHelper;

/**
 * Class ViewRenderer
 * @package drdim\yii\pug
 */
class ViewRenderer extends \yii\base\ViewRenderer
{

    /**
     * @var string the directory or path alias pointing to where Pug cache will be stored. Set to false to disable
     * templates cache.
     */
    public $cachePath = '@runtime/pug/cache';
    /**
     * @var array Pug options.
     * @see https://github.com/pug-php/pug
     */
    public $options = [
        'pretty' => true,
        'extension' => '.pug',
        'upToDateCheck' => true,
        'debug' => false,
        'expressionLanguage' => 'php',
    ];
    /**
     * @var array Custom filters.
     * Keys of the array are names to call in template, values are names of functions or static methods of some class.
     * Example: `['rot13' => 'str_rot13', 'jsonEncode' => '\yii\helpers\Json::encode']`.
     * In the template you can use it like this: `{{ 'test'|rot13 }}` or `{{ model|jsonEncode }}`.
     */
    public $filters = [];
    /**
     * @var Pug pug environment object that renders pug templates
     */
    public $pug;

    public function init()
    {
        $cachePath = empty($this->cachePath) ? false : Yii::getAlias($this->cachePath);

        if (!empty($cachePath) && !file_exists($cachePath)) {
            FileHelper::createDirectory($cachePath);

It seems like $cachePath defined by empty($this->cachePath) ? false : \Yii::getAlias($this->cachePath) on line 50 can also be of type boolean; however, yii\helpers\BaseFileHelper::createDirectory() does only seem to accept string, maybe add an additional type check?

        }

        if (!empty($cachePath) && !is_readable($cachePath)) {
            throw new Exception(\Yii::t('app', 'Pug cache path is not readable.'));
        }

        if (!empty($cachePath) && !is_writeable($cachePath)) {
            throw new Exception(\Yii::t('app', 'Pug cache path is not writable.'));
        }

        $this->pug = new Pug(array_merge([
            'cache' => $cachePath,
        ], $this->options));

        // Adding custom filters
        if (!empty($this->filters)) {
            foreach ($this->filters as $name => $handler) {
                $this->addFilter($name, $handler);
            }
        }
    }

    /**
     * Renders a view file.
     *
     * This method is invoked by [[View]] whenever it tries to render a view.
     * Child classes must implement this method to render the given view file.
     *
     * @param View $view the view object used for rendering the file.
     * @param string $file the view file.
     * @param array $params the parameters to be passed to the view file.
     *
     * @return string the rendering result
     */
    public function render($view, $file, $params)
    {
        return $this->pug->render($file, ['view' => $view] + $params);
    }

    /**
     * Adds custom filter
     * @param string $name
     * @param callable $handler
     */
    public function addFilter($name, $handler)
    {
        $this->pug->filter($name, $handler);
    }
}