YiiフレームにPHPテンプレートエンジンTwigを使用した例

5176 ワード

Twigは高速で安全で柔軟なPHPテンプレートエンジンです。多くのfilterとtagsを内蔵しています。そしてテンプレートの継承をサポートしています。一番簡潔なコードでテンプレートを説明できます。彼の文法はPythonのテンプレートエンジンJinjiaとDjangoのテンプレート文法とよく似ています。たとえば、私たちはPHPに変数を出力し、それを変換する必要がある場合、文法的に負担がかかります。

<?php echo $var ?>
<?php echo htmlspecialchars(\$var, ENT_QUOTES, 'UTF-8') ?>
ですが、Twigにはこのように書くことができます。

{{ var }}
{{ var|escape }}
{{ var|e }}         {# shortcut to escape a variable #}
エルゴード配列:

{% for user in users %}
  * {{ user.name }}
{% else %}
  No user has been found.
{% endfor %}
しかし、Yii FraamewarkでTwigを統合するにはちょっと面倒です。公式サイトにはTwigを統合できるプログラムがすでにあります。だからここでは詳しく説明しません。しかし、TwigではPHP文法がサポートされていませんので、一部の表現では難しいことがあります。例えば、Formのビューを書く時、よくこのように書きます。全部で二つの種類が必要です。TokenParsserとNode、直接コードを書きます。

<?php $form=$this->beginWidget('CActiveForm'); ?>
    <span>Login</span>
    <ul>
  <li>
    <?php echo $form->label($model,'username'); ?>
                <?php echo $form->textField($model,'username'); ?>

  </li>

  <li>
    <?php echo $form->label($model,'password'); ?>
                <?php echo $form->passwordField($model,'password'); ?>

  </li>

  <li class="last">
    <button type="submit">Login</button>

  </li>

</ul>
    <?php echo $form->error($model,'password'); ?>
<?php $this->endWidget(); ?>

、そしてTwig初期化のところに文法解析類を追加します。

<?php
/*
 * This file is an extension of Twig.
 *
 * (c) 2010 lfyzjck
 */

/**
 * parser widget tag in Yii framework
 *
 * {% beginwidget 'CActiveForm' as form %}
 *    content of form
 * {% endwidget %}
 *
 */
class Yii_WidgetBlock_TokenParser extends Twig_TokenParser
{
    /**
     * Parses a token and returns a node.
     *
     * @param Twig_Token $token A Twig_Token instance
     *
     * @return Twig_NodeInterface A Twig_NodeInterface instance
     */
    public function parse(Twig_Token $token)
    {
        $lineno = $token->getLine();
        $stream = $this->parser->getStream();

        $name = $stream->expect(Twig_Token::STRING_TYPE);
        if($stream->test(Twig_Token::PUNCTUATION_TYPE)){
            $args = $this->parser->getExpressionParser()->parseHashExpression();
        }
        else{
            $args = new Twig_Node_Expression_Array(array(), $lineno);
        }

        $stream->expect(Twig_Token::NAME_TYPE);
        $assign = $stream->expect(Twig_Token::NAME_TYPE);
        $stream->expect(Twig_Token::BLOCK_END_TYPE);

        $body = $this->parser->subparse(array($this, 'decideBlockEnd'), true);
        $stream->expect(Twig_Token::BLOCK_END_TYPE);

        return new Yii_Node_WidgetBlock(array(
            'alias' => $name->getValue(),
            'assign' => $assign,
        ), $body, $args, $lineno, $this->getTag());
    }

    /**
     * Gets the tag name associated with this token parser.
     *
     * @param string The tag name
     */
    public function getTag()
    {
        return 'beginwidget';
    }

    public function decideBlockEnd(Twig_Token $token)
    {
        return $token->test('endwidget');
    }
}

class Yii_Node_WidgetBlock extends Twig_Node
{
    public function __construct($attrs, Twig_NodeInterface $body, Twig_Node_Expression_Array $args = NULL, $lineno, $tag)
    {
        $attrs = array_merge(array('value' => false),$attrs);
        $nodes = array('args' => $args, 'body' => $body);
        parent::__construct($nodes, $attrs, $lineno,$tag);
    }

    public function compile(Twig_Compiler $compiler)
    {
        $compiler->addDebugInfo($this);
        $compiler->write('$context["'.$this->getAttribute('assign')->getValue().'"] = $context["this"]->beginWidget("'.$this->getAttribute('alias').'",');
        $argNode = $this->getNode('args');
        $compiler->subcompile($argNode)
                 ->raw(');')
                 ->raw("
");

        $compiler->indent()->subcompile($this->getNode('body'));

        $compiler->raw('$context["this"]->endWidget();');
    }
}
?>

、そしてtwigのテンプレートにこう書きます。

$twig->addTokenParser(new Yii_WidgetBlock_TokenParser);