File io/template/loader/CachedStringTemplateLoader.class.php

  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: 

<?php
/**
 * This loader is to use when you load a template whose source is directly a PHP string
 * and not a file. It supports caching and saves cache files in the /cache/tpl directory, using
 * a md5 hash to distinguish eache string input.
 * @package     IO
 * @subpackage  Template\loader
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Benoit SAUTEL <ben.popeye@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2014 12 22
 * @since       PHPBoost 3.0 - 2010 02 06
*/

class CachedStringTemplateLoader implements TemplateLoader
{
    private $content = '';
    private $cache_file_path = '';

    /**
     * Constructs a {@link CachedStringTemplateLoader} from the source string.
     * @param string $content The template's source as a string.
     */
    public function __construct($content)
    {
        $this->content = $content;
        $this->compute_cache_file_path();
    }

    private function compute_cache_file_path()
    {
        $this->cache_file_path = PATH_TO_ROOT . '/cache/tpl/string-' . md5($this->content) . '.php';
    }

    /**
     * {@inheritdoc}
     */
    public function load()
    {
        if (!$this->file_cache_exists())
        {
            $content = $this->get_parsed_content();
            $this->generate_cache_file($content);
            return $content;
        }

        return file_get_contents($this->cache_file_path);
    }

    private function file_cache_exists()
    {
        return file_exists($this->cache_file_path) && @filesize($this->cache_file_path) !== 0;
    }

    private function generate_cache_file()
    {
        try
        {
            $cache_file = new File($this->cache_file_path);
            $cache_file->open(File::WRITE);
            $cache_file->lock();
            $cache_file->write($this->get_parsed_content());
            $cache_file->unlock();
            $cache_file->close();
            $cache_file->change_chmod(0666);
        }
        catch(IOException $ex)
        {
            throw new TemplateLoadingException('The template file cache couldn\'t been written due to this problem: ' . $ex->getMessage());
        }
    }

    private function get_parsed_content()
    {
        $parser = new TemplateSyntaxParser();
        return $parser->parse($this->content);
    }

    /**
     * {@inheritdoc}
     */
    public function supports_caching()
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function get_cache_file_path()
    {
        if (!$this->file_cache_exists())
        {
            $content = $this->get_parsed_content();
            $this->generate_cache_file($content);
        }
        return $this->cache_file_path;
    }
}
?>