Spindle\View

Complexity

Total Complexity

44

Size/Duplication

Total Lines	316
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	12
Bugs	1	Features	4

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	getIterator()	0	4	1
A	__get()	0	4	1
A	__set()	0	4	1
A	__isset()	0	4	1
A	__toString()	0	8	2
A	toArray()	0	4	1
A	assign()	0	10	4
A	append()	0	4	1
A	prepend()	0	4	1
A	_merge()	0	13	3
A	render()	0	20	2
A	setContent()	0	4	1
A	content()	0	4	1
A	setLayout()	0	4	1
A	getLayout()	0	4	1
A	partial()	0	9	1
B	h()	0	8	5
D	meta()	0	33	9
B	_generateTag()	0	18	5

<?php
/**
 * spindle/view
 * @license CC0-1.0 (Public Domain)
 */
namespace Spindle;

use ArrayObject;

/**
 * 素のPHPテンプレートにlayout機能を付加するシンプルなレンダラーです
 */
class View implements \IteratorAggregate
{
    protected
        /** @var ArrayObject */ $_storage
    ,   /** @var string */ $_basePath
    ,   /** @var string */ $_fileName
    ,   /** @var string */ $_layoutFileName = ''
    ,   /** @var string */ $_content = ''
    ;

    /**
     * @param string $fileName 描画したいテンプレートのファイル名を指定します
     * @param string $basePath テンプレートの探索基準パスです。相対パスも指定できます。指定しなければinclude_pathから探索します。
     * @param ArrayObject $arr view変数の引き継ぎ元です。内部用なので通常は使う必要はありません。
     */
    public function __construct($fileName, $basePath='', ArrayObject $arr=null)
    {
        $this->_storage = $arr ?: new ArrayObject(array(), ArrayObject::ARRAY_AS_PROPS);
        $this->_fileName = trim($fileName, \DIRECTORY_SEPARATOR);
        $this->_basePath = rtrim($basePath, \DIRECTORY_SEPARATOR);
    }

    /**
     * このクラスはforeach可能です
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        return $this->_storage->getIterator();
    }

    /**
     * @param string|int $name
     * @return mixed
     */
    public function __get($name)
    {
        return $this->_storage[$name];
    }

    /**
     * @param string|int $name
     * @param mixed $value
     */
    public function __set($name, $value)
    {
        $this->_storage[$name] = $value;
    }

    /**
     * @param string|int $name
     * @return bool
     */
    public function __isset($name)
    {
        return isset($this->_storage[$name]);
    }

    /**
     * 描画するスクリプトファイルのパスを返します。
     * @return string
     */
    public function __toString()
    {
        if ($this->_basePath) {
            return $this->_basePath . \DIRECTORY_SEPARATOR . $this->_fileName;
        } else {
            return (string)$this->_fileName;
        }
    }

    /**
     * セットされたview 変数を配列化して返します
     * @return array
     */
    public function toArray()
    {
        return (array)$this->_storage;
    }

    /**
     * 配列で一気にview変数をセットします
     * @param array|\Traversable $array
     */
    public function assign($array)
    {
        if (!is_array($array) && !($array instanceof \Traversable)) {
            throw new \InvalidArgumentException('$array must be array or Traversable.');
        }

        foreach ($array as $key => $value) {
            $this->_storage[$key] = $value;
        }
    }

    /**
     * @param string $name
     * @param array $array
     */
    public function append($name, $array)
    {
        $this->_merge($name, (array)$array, true);
    }

    /**
     * @param string $name
     * @param array $array
     */
    public function prepend($name, $array)
    {
        $this->_merge($name, (array)$array, false);
    }

    /**
     * @param string $name
     * @param array $array
     * @param bool  $append
     */
    private function _merge($name, array $array, $append=true)
    {
        $s = $this->_storage;
        if (isset($s[$name])) {
            if ($append) {
                $s[$name] = array_merge((array)$s[$name], $array);
            } else {
                $s[$name] = array_merge($array, (array)$s[$name]);
            }
        } else {
            $s[$name] = $array;
        }
    }

    /**
     * テンプレートファイルを描画して文字列にして返します
     * テンプレート内では$EでHTMLエスケープでき、
     * <?= $E('<script>') ?> と <?= htmlspecialchars('<script>') ?> が等価です。
     *
     * @return string
     */
    public function render()
    {
        $E = get_class($this) . '::h';
        extract((array)$this->_storage, \EXTR_OVERWRITE);
        ob_start();
        include (string)$this;
        $html = ob_get_clean();

        if ($this->_layoutFileName) {
            $layout = new static(
                $this->_layoutFileName,
                $this->_basePath,
                $this->_storage
            );
            $layout->setContent($html);
            return $layout->render();
        } else {
            return $html;
        }
    }

    /**
     * @internal
     * @param string $content
     */
    protected function setContent($content)
    {
        $this->_content = $content;
    }

    /**
     * 子テンプレートの描画結果を文字列として返します
     * @return string
     */
    public function content()
    {
        return $this->_content;
    }

    /**
     * 親となるレイアウトテンプレートのファイル名を指定します。
     * レイアウトは__construct()で指定した基準パスと同じパスから探索します。
     * @param string $layoutFileName
     */
    public function setLayout($layoutFileName)
    {
        $this->_layoutFileName = $layoutFileName;
    }

    /**
     * 現在セットされているレイアウトファイル名を返します
     * @return string
     */
    public function getLayout()
    {
        return $this->_layoutFileName;
    }

    /**
     * 指定したテンプレートファイルを描画します。
     * 変数は引き継がれます。
     * @param string $partialFileName
     * @return string
     */
    public function partial($partialFileName)
    {
        $partial = new static(
            $partialFileName,
            $this->_basePath,
            $this->_storage
        );
        return $partial->render();
    }

    /**
     * htmlspecialchars()のエイリアスです。
     *
     * @param string $rawStr 
     * @param int $mode
     * @param string $charset 文字コードです。指定しなければdefault_charsetの値を使用します。
     * @return string
     */
    public static function h($rawStr, $mode=\ENT_QUOTES, $charset=null)
    {
        static $solvedCharset = null;
        if (!$solvedCharset || !empty($charset)) {
            $solvedCharset = (string)$charset ?: ini_get('default_charset') ?: 'UTF-8';
        }
        return \htmlspecialchars($rawStr, $mode, $solvedCharset);
    }

    /**
     * metaタグ群を出力するためのヘルパー関数です。
     * <?= self::meta($meta) ?>
     *
     * @example
     *  <pre>
     *   $meta = [
     *     'charset' => 'utf8',
     *     'http-equiv' => [
     *       'X-UA-Compatible' => 'IE=edge',
     *       'Content-Type' => 'text/html; charset=UTF-8',
     *     ],
     *     'name' => [
     *       'keyword' => 'hoge,fuga,muga',
     *       'description' => 'hogehoge',
     *       'twitter:title' => 'Mountain sunset',
     *     ],
     *     'property' => [
     *       'og:title' => 'foooooo',
     *       'og:description' => 'hogehoge',
     *       'og:image' => [
     *         'http://hoge.com/hoge1.jpg',
     *         'http://hoge.com/hoge2.jpg',
     *       ],
     *     ],
     *   ];
     *  </pre>
     *
     * @param array|Traversable $meta metaタグの定義。
     * @param boolean $isXhtml trueを指定すると、タグがXHTML形式になります。
     * @param boolean $escape  falseを指定すると、HTMLエスケープを行わなくなります。
     * @return string
     */
    public static function meta($meta, $isXhtml=false, $escape=true)
    {
        if (!is_array($meta) && !$meta instanceof \Traversable) {
            throw new \InvalidArgumentException('$meta should be Traversable or array. type error: ' . gettype($meta));
        }

        $html = array();
        foreach ($meta as $attr => $defs) {
            if (is_scalar($defs)) {
                $html[] = array('meta', $attr => $defs);
                continue;
            }

            foreach ($defs as $label => $val) {
                if (is_scalar($val)) {
                    $html[] = array('meta', $attr => $label, 'content' => $val);
                    continue;
                }

                foreach ($val as $v) {
                    $html[] = array('meta', $attr => $label, 'content' => $v);
                }
            }
        }

        $metatags = array();
        foreach ($html as $def) {
            $metatags[] = self::_generateTag($def, $isXhtml, $escape);
        }

        sort($metatags, \SORT_STRING);
        return implode(PHP_EOL, $metatags);
    }

    private static function _generateTag(array $def, $isXhtml=false, $escape=true)
    {
        $tag = $def[0];
        unset($def[0]);

        $html = array();
        if ($escape) {
            foreach ($def as $key => $val) {
                $html[] = $key . '="' . static::h($val, \ENT_COMPAT) . '"';
            }
        } else {
            foreach ($def as $key => $val) {
                $html[] = $key . '="' . $val . '"';
            }
        }

        return "<$tag " . implode(' ', $html) . ($isXhtml ? ' />' : '>');
    }
}