FuelPHP, a PHP 5.3 Framework Documentation

Observers: Included observers

付属のオブザーバーは以下に記載されています:

• Observer_Self
• Observer_CreatedAt
• Observer_UpdatedAt
• Observer_Validation
• Observer_Typing
• Observer_Slug

Observer_Self

良い習慣ではありませんが、場合によっては、あなたのモデルとイベントメソッドだけを持っているのはおそらく最も クリーンです。 もしモデルがイベントにちなんで命名され、_event_ で始まるメソッドを持っている場合は、 Observer_Self の出番です。たとえば after_save イベントの場合、 あなたは public メソッドの _event_after_save() を 使っているモデルに追加する必要があり、それは モデル自体のオブザーバの呼び出しを持つことができます。

// オブザーバを追加します
protected static $_observers = array('Orm\\Observer_Self');

// But if you only observe some events you can optimize by only adding those
protected static $_observers = array('Orm\\Observer_Self' => array(
	'events' => array('after_save', 'before_insert')
));

Observer_CreatedAt

このオブザーバはbefore_insertだけに作用します。created_atプロパティを持っている モデルが初めて保存するとき、Unixタイムスタンプがセットされます。

// オブザーバを追加します。
protected static $_observers = array('Orm\\Observer_CreatedAt');

// 設定追加:
// - before_insertのみで実行する必要
// - mysqlのタイムスタンプを使用（デフォルトではUNIXタイムスタンプを使用しています）
// - "created_at"の代わりに"created"を使用
protected static $_observers = array(
	'Orm\\Observer_CreatedAt' => array(
		'events' => array('before_insert'),
		'mysql_timestamp' => true,
		'property' => 'created',
	),
);

Observer_UpdatedAt

このオブザーバーは before_saveの時に機能します。 あなたのモデルが updated_atプロパティがあると想定し、保存するとき(もしくは最初に）、 そのプロパティはUnixタイムスタンプが設定されます。

// オブザーバを追加します。
protected static $_observers = array('Orm\\Observer_UpdatedAt');

// 設定追加:
// - before_saveのみで実行する必要あり
// - mysqlのタイムスタンプを使用（デフォルトではUNIXタイムスタンプを使用しています）
// - "updated_at"の代わりに、"updated"を使用
protected static $_observers = array(
	'Orm\\Observer_UpdatedAt' => array(
		'events' => array('before_save'),
		'mysql_timestamp' => true,
		'property' => 'updated',
	),
);

Observer_Validation

このオブザーバのみbefore_saveに作用します。これは、検証規則が失敗した場合の保存からモデルを防ぐために使用されます。 それは、 Fieldsetクラスを使用し、 またあなたのためのフォームを生成することができます。

主要なキーは編集できませんし、検証にも、フォームにも追加されません。 そしてほとんどの場合自動インクリメントとなります。それを創造の上に置いて、確認を必要とする場合、 あなたは手動でフィールドを加える必要があります。

オブザーバーは、以下のようにロードすることができます:

// オブザーバを追加します。
protected static $_observers = array('Orm\\Observer_Validation');

// But adding it just for before_save is enough
protected static $_observers = array('Orm\\Observer_Validation' => array(
	'events' => array('before_save')
));

検証ルールは $_properties でモデルで定義する必要があります。 これは、モデルの作成に示されています。 あなたが検証オブザーバーを追加した後、モデルのデータを保存する前に検証に失敗した場合、Orm\ValidationFailed に例外が投げられます。 このようにモデルの save メソッドの呼び出しを try/catch する必要が あります。

より広範な機能例/scaffoldingを以下に示します:

class Controller_Articles extends Controller
{
	public function action_create()
	{
		$view = View::forge('articles/create');
		if (Input::param() != array())
		{
			try
			{
				$article = Model_Article::forge();
				$article->name = Input::param('name');
				$article->url = Input::param('url');
				$article->save();
				Response::redirect('articles');
			}
			catch (Orm\ValidationFailed $e)
			{
				$view->set('errors', $e->getMessage(), false);
			}
		}
		return new Response($view);
	}

	public function action_edit($id = false)
	{
		if ( ! ($article = Model_Article::find($id))
		{
			throw new HttpNotFoundException();
		}

		$view = View::forge('articles/edit');
		if (Input::param() != array())
		{
			try
			{
				$article->name = Input::param('name');
				$article->url = Input::param('url');
				$article->save();
				Response::redirect('articles');
			}
			catch (Orm\ValidationFailed $e)
			{
				$view->set('errors', $e->getMessage(), false);
			}
		}
		return new Response($view);
	}

	public function action_delete($id = null)
	{
		if ( ! ($article = Model_Article::find($id))
		{
			throw new HttpNotFoundException();
		}
		else
		{
			$article->delete();
		}
		Response::redirect('articles');
	}

}

これは、Fieldsetクラスを使用しているので、検証を実行し、 また、モデル用のフォームを作成することができます。次の例では、作成と編集フォームが一般的なビューで定義されています。 しかし、同じように簡単にモデルにそれを定義し、 Fieldset::instance()を使用することで、 viewでそれのインスタンスを取得することができます。

// フォームを作成するModel_Articleのインスタンスを使用して、あなたはまた、クラス名を渡すことができます。
$fieldset = Fieldset::forge()->add_model($article);

// モデルのインスタンスからの値を使用してフォームを移入します。
// trueを渡しても、セーブ失敗した後に再設定するためにPOST/PUTを使用します。
$fieldset->populate($article, true);

// フィールドセットは、文字列へのキャスト時にHTMLとしてビルドされます。
echo $fieldset;

Observer_Typing

これは2つのもののためのものです: 入力のための型強制とDBからの出力のための型キャストです。 つまり、 あなたがタイピングオブザーバを保存しているときにすることは予想される型に入力値をキャストしようとすることで、 それができないは例外をスローします。そして、あなたがDBのデータを取得しているとき、 通常、それはすべての文字列になります（偶数整数および浮動小数点数）が、タイピングオブザーバでそれらはそれらのスカラ型にキャストされます。

タイピングオブザーバーは上記のほかに、シリアル＆JSONフィールドのサポートを追加します。どちらも 文字列型のフィールドである必要があります（"テキスト"が望ましい）。 しかし保存用に(serialize() もしくは json_encode()を使って)エンコードされたの値を持つことになり、そして DBから取得する際には(unserialize() もしくは json_decode()を使って)デコードをします。

Observer_Typingが検証に代わるものとして意図されていないため、検証としてそれを使用しようと しないでください。どちらもあなたのサイトの訪問者によって読まれることを意図してこのオブザーバによってスローされた例外はありません。 コードをデバッグするのに役立つことを意図しています。

// オブザーバを追加します。
protected static $_observers = array('Orm\\Observer_Typing');

// But adding it just for these specific events is enough
protected static $_observers = array('Orm\\Observer_Typing' => array(
	'events' => array('before_save', 'after_save', 'after_load')
));

このObserverを動作させるために、あなたは、モデル内の静的変数$_propertiesをセットをする、 もしくは設定をせずにすべてをDB::list_columns()（MYSQLのみ！）で検出を使用します。 それを自分で設定する場合は以下の設定が可能です：

Observer_Slug

このオブザーバは、モデル固有のURL安全スラグを作成します。 それは "before_insert"時にのみ動作し、 あなたのモデルがタイトル（スラグを作成するため）とスラグ（スラグを保存するため）プロパティを持つことを想定しています。

//オブザーバを追加します。
protected static $_observers = array('Orm\\Observer_Slug');

// 設定
protected static $_observers = array(
	'Orm\\Observer_Slug' => array(
		'events' => array('before_insert'),
		'source' => 'title',   // 上にスラグをベースに使用されるプロパティはプロパティの配列かもしれません。
		'property' => 'slug',  // プロパティが空のときにスラグを設定します。
	),
);
protected static $_observers = array('Orm\\Observer_Slug' => array('before_insert'));

オブザーバは Inflector::friendly_title() を使用してtitle から slug を作成し、スラグが既に存在する場合は、インデックスを追加します。