File common/utils/Views.php | HJI WP Membership Code Reference

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258

<?php
/**
 * This class first looks in theme's folder
 * then in the views, therefore allowing overwriting
 * of templates.
 */

namespace hji\common\utils;

use \hji\membership\Membership;
use \hji\common\utils\View as BaseView;


class Views
{
    protected $vars = array();
    protected $templatesDir = array();
    protected $fileName = null;
    protected $textdomain = 'hji-textdomain';


    function __construct($templatesDir = null)
    {
        if ($templatesDir)
        {
           $this->templatesDir = array_merge($this->templatesDir, (array)$templatesDir);
        }
    }


    /**
     * Sets the text domain variable for templates
     *
     * @param $textdomain
     */
    public function setTextdomain($textdomain)
    {
        $this->textdomain = $textdomain;
    }


    /**
     * Sets the filename for the template
     *
     * @param $fileName
     */
    public function setFileName($fileName)
    {
        $this->fileName = $fileName;
    }


    function getFileName()
    {
        return $this->fileName;
    }


    /**
     * Setter for template variables array
     *
     * @param $name
     * @param $value
     */
    public function set($name, $value)
    {
        $this->vars[$name] = $value;
    }


    /**
     * Getter for template variables array
     *
     * @param $name
     * @return null
     */
    public function get($name)
    {
        return (isset($this->vars[$name])) ? $this->vars[$name] : null;
    }


    /**
     * Validates that a filename was passed correctly when calling render method
     *
     * @param $fileName
     * @return null|void
     */
    protected function _validateFile($fileName)
    {
        if (!$fileName)
        {
            if (!$this->fileName)
            {
                trigger_error("Template file name is required.", E_USER_ERROR);

                return;
            }
            else
            {
                $fileName = $this->fileName;
            }
        }

        return $fileName;
    }


    /**
     * Prepares and validates we've passed template variables
     *
     * @param $vars
     * @return bool|void
     */
    protected function _prepareVars()
    {
        $vars = $this->vars;

        if (!isset($vars['textdomain']) || empty($vars['textdomain']))
        {
            $vars['textdomain'] = $this->textdomain;
        }

        return $vars;
    }


    /**
     * Locates the template for rendering
     *
     * @param bool|false $fileName
     * @return string
     */
    protected function _locateTemplate($fileName = false)
    {
        if ($this->_isTwig($fileName))
            return $fileName;

        $fileName = $fileName . '.phtml';

        $template = locate_template(array(
            'hji-templates/' . $fileName,
            $fileName
        ));

        if ($template == '')
        {
            foreach ($this->templatesDir as $dir)
            {
                $_template = trailingslashit($dir) . $fileName;

                if (file_exists($_template))
                {
                    return $_template;
                }
            }
        }

        return $template;
    }


    /**
     * Renders the template based upon the file type
     *
     * @param       $template
     * @param array $vars
     * @return bool|string
     */
    protected function _renderTemplate($template, $vars = array())
    {
        if ($this->_isTwig($template))
        {
            require_once Membership::$dir . '/third-party/timber/timber.php';

            $this->_configureTwig();

            return \Timber::compile($template, $vars);
        }
        else
        {
            return BaseView::render($template, $vars);
        }
    }


    /**
     * Render method for rendering a .phtml or .twig template
     *
     * @param bool|false       $fileName
     * @param array|bool|false $vars
     * @return bool|string
     */
    public function render($fileName = false, $vars = null)
    {
        if ($fileName)
        {
            $this->setFileName($fileName);
        }

        if (is_array($vars))
        {
            $this->vars = $vars;
        }

        $fileName = $this->_validateFile($this->getFileName());

        return $this->_renderTemplate($this->_locateTemplate($fileName), $this->_prepareVars());
    }


    /**
     * Checks if a file is a .twig template
     *
     * @param $fileName
     * @return bool
     */
    protected function _isTwig($fileName)
    {
        if (substr($fileName, -5, 5) == '.twig')
        {
            return true;
        }

        return false;
    }


    /**
     *  Configures Timber correctly for .twig templates
     *
     */
    protected function _configureTwig()
    {
        \Timber::$cache = true;
        \Timber::$locations = $this->templatesDir;
        add_filter('twig_apply_filters', array($this, 'setTwigCachePath'));
    }


    /**
     * Sets the twig cache path
     *
     * @param $twig
     * @return mixed
     */
    public function setTwigCachePath($twig)
    {
        if (!file_exists(WP_CONTENT_DIR . '/hji-cache/twig'))
        {
            mkdir(WP_CONTENT_DIR . '/hji-cache/twig', 0700, true);
        }

        $twig->setCache(WP_CONTENT_DIR . '/hji-cache/twig');

        return $twig;
    }
}

Namespaces

Classes

Interfaces

Functions