spindle/view

simple layout renderer

Installs: 28

Dependents: 0

Stars: 1

Watchers: 1

Forks: 1

Language: PHP

1.0.3 2015-04-19 15:28 UTC

README

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads Latest Unstable Version License

素のPHPをテンプレートエンジンとして使う際、レイアウト構造を実現するライブラリです。 1つのクラスだけの非常に小さなライブラリですが、"継承"機能をほぼ網羅しています。

自動エスケープなどの機能はありませんが、最低限のエスケープ機能はhelperとして実装してあります。

インストールにはcomposerが使えます。

$ composer require "spindle/view:*"

バージョン1.0.2より、GitHubのzip-archiveには最小限のソースコードのみ含まれるようにしています。 testやexampleが必要な場合はこのリポジトリを参照するか、--prefer-sourceオプションを使ってください。

$ composer require "spindle/view:*" --prefer-source

使い方

クラス一つだけなので、require_onceで読み込むこともできますし、composerでオートロードしても構いません。

1. シンプルな例

template.phtmlは素のPHPで書かれたテンプレートファイルとします。 $titleと$mainを埋めるとHTMLの文字列が完成します。

<html>
<head>
 <title><?= $title ?></title>
</head>
<body>
 <h1><?= $title ?></h1>
 <div class="main">
  <?= $main ?> 
 </div>
</body>
</html>

これをHTML化するには、以下のようなスクリプトを書きます。

<?php
require 'vendor/autoload.php';

$view = new Spindle\View('template.phtml');
$view->title = 'Spindle Example';
$view->main  = 'Hello! Spindle/View!';

echo $view->render();

render()メソッドはテンプレートファイルを文字列化して返します。 render()メソッドだけでは画面に出力しないので、必要に応じてechoで出力してください。

1-1. ビュー変数の渡し方

テンプレートファイルに値を渡す際は、いくつかやり方があります。

//一つ一つ渡す
$view->title = 'sample';
$view->data = array(1,2,3);

//連想配列からまとめて渡す
$view->assign(array(
    'title' => 'sample',
    'data' => array(1,2,3),
));

// compactを使うとこんな書き方でもOK
$title = 'sample';
$data = array(1,2,3);
$view->assign(compact('title', 'data'));

一方、受け取る側のテンプレートファイルでは、変数は展開されています。 $title$dataで参照できます。 $this->title$this->dataでも同じものが取れます。 thisを付ける書き方は冗長ですが、変数の書き換えを行った際に、挙動に違いが出ます。 詳しくはレイアウトの項で説明します。

<!-- 同じ意味 -->
<title><?= $title ?></title>
<title><?= $this->title ?></title>

<ul>
<?php foreach ($data as $i): ?>
 <li><?= $i ?></li>
<?php endforeach ?>
</ul>

渡せる変数の型には制限はありません。オブジェクトをそのまま渡すこともできます。

テンプレートファイルはPHPの通常の関数と違い、どんな引数を取るのか明示していません。 あまり多くの変数を渡すより、オブジェクトにまとめて一つか二つ渡す方が メンテナンスしやすくなると思います。

1-2. ビュー変数のスコープ

ビュースクリプトは関数内で評価されるため、変数のスコープはローカルです。 テンプレートファイルの中で適当に変数を作ったり書き換えたりしても、その場限りであり、グローバル空間を汚染しません。

1-3. テンプレートファイルの探索パス

template.phtmlをどこから探してくるかですが、特に何も指定しなければ include_pathを順番に探します。PHPの設定を変えていないなら、 viewのスクリプトと同じパスが最優先で探索されます。

特定のパスから指定したい場合は第2引数で探索基準パスを指定してください。 絶対パスでも相対パスでもOKです。

$view = new Spindle\View('template.phtml', '/path/to/template');

2. レイアウト

テンプレートは入れ子状にすることができます。

template.phtmlが以下のように書いてあったとして、

<?php $this->setLayout('layout.phtml') ?>
template

そしてlayout.phtmlが以下のように書いてあったとすると、

<div>
<?= $this->content() ?>
</div>

template.phtmlの結果は以下のようになります。

<div>
template
</div>

template.phtmlが親となるべきレイアウトテンプレートを指定していることに注意してください。 $this->content()は、子テンプレートが存在するときはその描画結果が返り、単体で呼び出される場合は空文字が返ります。

2-1. テンプレートの描画順序

テンプレートは内側から描画されていきます。 そのため、ビュー変数に何か加工を加えると、外側のレイアウトテンプレートに影響を与えます。 詳しくは example/03 を見てください。

特に、配列型のビュー変数を操作すると、思ったような挙動にならないことがあります。 $this->append($name, array( ... ))$this->prepend($name, array( ... ))を使うと、配列型のビュー変数を、より意図通りの挙動で扱えるようになります。

3. 入れ子のレイアウト

レイアウトは無限に入れ子にできます。(実際はコンピュータのメモリの許す限り、ですが。) 親のレイアウトテンプレートが、更にsetLayoutしていれば、どんどん入れ子にできます。

詳しくは example/04 を見てください。

4. パーシャルテンプレート

PHPのinclude文の代わりに、$this->partial()というメソッドが使えます。同じ基準パスからテンプレートを探索できるし、パーシャルテンプレートもsetLayoutによって入れ子にできます。

詳しくは example/05およびexample/06を見てください。

License

Spindle/Viewの著作権は放棄するものとします。 利用に際して制限はありませんし、作者への連絡や著作権表示なども必要ありません。 スニペット的にコードをコピーして使っても問題ありません。

ライセンスの原文

CC0-1.0 (No Rights Reserved)