AuraフレームワークはAura.Viewをデフォルトのテンプレートとして使用します。
しかしHari.Extrasで行っている様に他のテンプレートシステムを使う事もできます。
Aura ViewパッケージはTemplateViewパターンの実装です。
これには自動エスケープや”path stacks”、ヘルパー等のサポートも含まれています。
「PHPをプレゼンテーションロジックのために使用する」という方針を固持していますが、Savant、Zend_View、それに
Solar_Viewなどで置き換えることができます。
$this->data = [
'foo' => 'value of foo',
'bar' => 'value of bar',
];$this を使ってテンプレートスクリプトからプロパティを利用するこができます。：
// template script
<?= $this->foo; ?>
<?= $this->bar; ?>Aura Viewテンプレートスクリプトは素のPHPで書かれ新しいマークアップ言語を必要としません。
テンプレートスクリプトはTemplateオブジェクトスコープ内部で実行されます。
そのとき$thisはTemplate オブジェクトを指しています。以下にスクリプト例を示します。
<html>
<head>
<title><?= $this->title; ?></title>
</head>
<body>
<p><?= "Hello " . $this->var . '!'; ?></p>
</body>
</html>We can use any PHP code we would normally use. (This will require discipline on the part of the template script author to restrict himself to presentation-related logic only.)
PHPコードを通常通りに使用します（ここにはプレゼンテーションのためのロジックしか記述しません） 条件分岐やループのための表記はこのようになります。
<?php if ($this->model->hasMessage()): ?>
<p>The message is <?= $this->model->getMessage(); ?></p>
<?php endif; ?>
<ul>
<?php foreach ($this->list as $item): ?>
<li><?= $item; ?></li>
<?php endforeach; ?>
</ul>Aura View はテンプレートにアサインされたデータをアクセスする時に自動でエスケープ処理が行われます。通常はテンプレート内で手動で適用する必要はありません
アサインされた文字列はアクセスに応じて自動的にエスケープされます： integers, floats, booleans, それに nulls と not
もし配列がアサインされたらそのキーと値はアクセスされたときにエスケープされます
もしオブジェクトがアサインされたらプロパティとメソッドの返り値はアクセスされたときにエスケープされます
ビジネスロジックのデータがテンプレートにアサインされた例です …
<?php
/**
* @var object $obj An object with properties and methods.
* @var array $arr An associative array.
* @var string $str A string.
* @var int|float $num An actual number (not a string representation).
* @var bool $bool A boolean.
* @var null $null A null value.
*/
$this->data = [
'obj' => $obj,
'arr' => $arr,
'str' => $str,
'num' => $num,
'bool' => $bool,
'null' => null,
];… そしてこれはテンプレートでの自動エスケープの例です。
<?php
// strings are auto-escaped whenever you access them
echo $this->str;
// integers, floats, booleans, nulls, and resources are not escaped
if ($this->null === null || $this->bool === false) {
echo $this->num;
}
// array keys and values are auto-escaped per the string/number/etc
// rules listed above
foreach ($this->arr as $key => $val) {
// the key and value are already escaped for us
echo $key . ': ' . $val;
}
// object properties and method returns are auto-escaped per the
// string/number/etc rules listed above
echo $this->obj->property;
echo $this->obj->method();
// if the object implements Iterator or IteratorAggregate,
// the iterator keys and values are auto-escaped as well
foreach ($this->obj as $key => $val) {
echo $key . ': ' . $val;
}エスケープはアクセス時に行われ、アサインの時では無いのに注意してください。 テンプレートにアサインされた値にアクセスした時のみに行われます。
もしテンプレート内で作成した値があれば、escape() ヘルパーを使って自身でエスケープする必要があります。
<?php
$var = "this & that";
echo $this->escape($var);もしエスケープしない値をアクセスしたときには__raw()メソッドを使います。
<?php
// get the raw assigned string
echo $this->__raw()->str;
// get the count of an assigned array or object
echo count($this->__raw()->arr);
// see if the assigned array is empty
if (! $this->__raw()->arr) {
echo "Array is empty.";
}
// get a raw property from an assigned object;
// either of the following will work:
echo $this->__raw()->obj->property;
echo $this->obj->__raw()->property;
// get a raw method result from an assigned object;
// either of the following will work:
echo $this->__raw()->obj->method();
echo $this->obj->__raw()->method();
// check if an object is an instanceof SomeClass
if ($this->__raw()->obj instanceof SomeClass) {
// ...
}配列やCountableオブジェクトからcount()を求めるには生の値が必要です。
これは元の値にエスケープをするオブジェクトがラッピング（デコレーティング）され自動エスケープが行われてしまうためです。
このデコレーションは配列のキーと値、オブエクとのプロパティとメソッドに対して自動エスケープする事を可能にしますが、
一方implements や instanceofといった事ができる機能が利用できなくなってしまいます事に注意が必要です。
There is an escaping “gotcha” to look out for when manipulating values after they are assigned to a template. If you use an assigned value and re-assign it to the template, the new value will be double-escaped when you access it.
テンプレートにアサインされた後の値を操作したときに、エスケープが面倒な事にならないように注意する必要があります。 もしアサインされた値を再びアサインすると新しい値はアクセスしたときに二重エスケープされてしまうでしょう。
例えばこのようなビジネスロジックが与えられたとします …
<?php
// business logic
$this->data->foo = "this & that";.. テンプレートスクリプトはこれです …
<?php
// template script
$this->bar = $this->foo . " & the other";
echo $this->bar;… この時、アウトプットは二重エスケープされた"this &amp; that & the other"になってしまいます。
これは$this->foo をアクセスしたときにエスケープされた後、出力のときに$this->barがアクセスされたときに
更に自動エスケープされてしまうためです。
__raw()このような操作を行うときには__raw()の値を使います：
<?php
// template script
$this->bar = $this->__raw()->foo . " & the other";
echo $this->bar;これで出力は"this & that & the other"と正しく一度だけ行われる様になりました。
Aura View は様々な Helper クラスを共通のプレゼンテーションロジックに利用する事ができます。
これらのヘルパーはTemplateオブジェクトにHelperLocatorを通じてマップされています。
コールする方法は二通りです：
Template オブジェクトのメソッドとして
オブジェクトがもつgetHelper()でヘルパーを取得します
We have already discussed the escape() helper above. Other helpers that are
part of Aura View include:
escape()ヘルパーを利用した例は見てきました。Aura Viewの他のヘルパーは以下のようなものがあります。
$this->anchor($href, $text)は<a href="$href">$text</a>タグを返します。
$this->attribs($list)は$listからキー/バリューのペアの空白区切りのリストを返します。
$this->base($href)は <base href="$href" />タグを返します。
$this->datetime($datestr, $format)はフォーマットされたdatetime文字列を返します。
$this->image($src) は <img src="$src" /> タグを返します。
$this->input($attribs, $value, $label, $label_attribs) は <input>タグを返しますが、オプションで <label> タグを返す事もできます。
$this->input(['type' => $type], $value, $label, $label_attribs) の中で $value, $label and $label_attribs はオプションです。
Supported types: サポートするタイプ
button : クリックできるボタンcheckbox : チェクボックスcolor : カラーピッカーdate : 日付コントロール（年、月、日）datetime : 日付と時間のコントロール（年、月、日、時間、分、秒、秒以下の値、UTCタイムゾーン）datetime-local : 日付と時間のコントロール（年、月、日、時間、分、秒、秒以下の値、タイムゾーンは含まない）email : e-mailアドレスfile : ファイルアップロードのための”Browse…” ボタンhidden : hiddenインプットフィールドimage : サブミット用の画像month : 月日コントロール(タイムゾーンなし)number : 数値入力password : パスワードフィールドradio : ラジオボタンrange : 正確な値を必要としない（スライダーのような）数値入力コントロールreset : リセットボタン（全てのフォームをデフォルト値にリセット）search : 検索文字列を入力するためのテキストフィールドsubmit : 送信ボタンtel : 電話番号text : (デフォルト) 単一行のテキストフィールドtime : タイムコントロール（タイムゾーンなし）url : URLフィールドweek : 週と年のコントロール (タイムゾーンなし)このような例になります
$this->input(['type' => 'text', ... ], 'field value')
$this->input(['type' => 'checkbox', 'value' => 'yes'], 'yes')
$this->metas() は <meta ... /> タグを取得したり追加できるオブジェクトを用意します。
$this->metas()->addHttp($http_equiv, $content) HTTP-equivalent メタタグをヘルパーに追加します。
$this->metas()->addName($name, $content) メタ名のタグをヘルパーに追加します
$this->metas()->get() 追加された全てのタグを取得します。
$this->scripts() は <meta ... /> タグを取得したり追加できるオブジェクトを用意します。タグを取得したり追加できるオブジェクトを用意します。
$this->scripts()->add($src) はヘルパーにスクリプトタグを追加します。
$this->scripts()->addCond($exp, $src) 条件式のスクリプトタグを追加します。
$this->scripts()->get() ヘルパーに追加された全てのタグを返します。
$this->styles() は <link rel="stylesheet" ... /> タグを追加したり取得できるオブジェクトを用意します。
$this->styles()->add($href) ヘルパーにスタイルタグを追加します。
$this->styles()->get() ヘルパーに追加された全てのタグを返します。
$this->textarea($attribs, $html) <textarea> を返します。$htmlはオプションです。
$this->title() <title>...</title> タグを操作するオブジェクトを用意します。
$this->title()->set($title) タイトルの値をセットします。
$this->title()->append($suffix) タイトルの値に追加します。
$this->title()->prepend($prefix) タイトルの値の前に追加します。
$this->title()->get() タイトルタグと値を返します。
It often makes sense to split one template up into multiple pieces. This allows us to keep logical separations between different pieces of content. We might have a header section, a navigation section, a sidebar, and so on.
We can use the $this->find() method in a template script to find a template,
and then include it wherever we like. For example:
<html>
<head>
<?php include $this->find('head'); ?>
</head>
<body>
<?php include $this->find('branding'); ?>
<?php include $this->find('navigation'); ?>
<p>Hello, <?= $this->var; ?>!</p>
<?php include $this->find('foot'); ?>
</body>
</html>Templates that we include in this way will share the scope of the template
they are included from.
Template partials are a scope-separated way of splitting up templates. In
doing so, we can pass an array of variables to be used in the partial
template; they will be available under $this in place of the parent
template variables. For example, given the following partial template …
テンプレートはスコープに応じてそれぞれの部分に分割されていて、そのため部分的な値を渡す事が
できます; they will be available under $this in place of the parent
template variables.例えばこれらのパーシャル（部分的な）テンプレートは…
<?php
// partial template named '_item.php'.
echo " <li>{$this->item}</li>" . PHP_EOL;… 他のテンプレートからこのテンプレートを部分的に使う事ができます。
<?php
// main template. assume $this->list is an array of items.
foreach ($this->list as $item) {
$template_name = '_item';
$template_vars = ['item' => $item];
echo $this->partial($template_name, $template_vars);
}That will run the $template_name template script in a separate scope, and
the $template_vars array will be available as $this properties within that
separate scope.
他のスコープの中では$template_name テンプレートスクリプトが実行されいます。そして
$template_vars配列は他のスコープ内の$thisプロパティで利用されます。
N.b.: We can also
fetch()other templates from within a template; template scripts that are fetched in this way will not share the scope of the template they are called from (although$thiswill still be available).
新しいヘルパーを追加するには２つの手順があります：
ヘルパークラスをかく
HelperLocatorのサービスとしてクラスを追加する。
ヘルパークラスをかくのは難しくありません。 AbstractHelperを拡張して__invoke() メソッドを記述します。
この例のヘルパーはROT-13を文字列にするものです。
<?php
namespace Vendor\Package\View\Helper;
use Aura\View\Helper\AbstractHelper;
class Obfuscate extends AbstractHelper
{
public function __invoke($string)
{
return str_rot13($input);
}
}これでヘルパークラスを持つ事ができました。サービスとしてHelperLocator に追加します：
<?php
// business logic
$di->params['Aura\View\HelperLocator']['registry']['obfuscate'] = function () use ($di) {
return $di->newInstance('Vendor\Package\View\Helper\Obfuscate');
};HelperLocatorのサービスの名前はメソッド名とTemplateオブジェクトに使われます。
これは $this->obfuscate()メソッド経由でヘルパーが呼ばれるという事です。
<?php
// template script
echo $this->obfuscate('plain text');注）ヘルパーにはどんな名前でもつけることができます。ただし、ヘルパークラスにとって充分な名前である必要があるでしょう
Aura\View\Helperクラスろもっと複雑でパワフルな例をを調べてみてください。