Yaf_Dispatcher クラス

(Yaf >=1.0.0)

はじめに

Yaf_Dispatcher の役割は、リクエスト環境の初期化、やってきたリクエストのルーティング、そして見つかったアクションへのディスパッチです。あらゆるレスポンスを取りまとめ、処理が完了した後でそれを返します。

Yaf_Dispatcher はシングルトンパターンを実装しています。つまり、同時に複数のインスタンスは作れないということです。そのため、このクラスをレジストリとして使い、ディスパッチ中に他のオブジェクトから参照させることもできます。

クラス概要

final class Yaf_Dispatcher {

/* プロパティ */

protected $_router;

protected $_view;

protected $_request;

protected $_plugins;

protected static $_instance;

protected $_auto_render;

protected $_return_response;

protected $_instantly_flush;

protected $_default_module;

protected $_default_controller;

protected $_default_action;

/* メソッド */

public __construct()

public autoRender(bool $flag = ?): Yaf_Dispatcher

public catchException(bool $flag = ?): Yaf_Dispatcher

public disableView(): bool

public dispatch(Yaf_Request_Abstract $request): Yaf_Response_Abstract

public enableView(): Yaf_Dispatcher

public flushInstantly(bool $flag = ?): Yaf_Dispatcher

public getApplication(): Yaf_Application

public getDefaultAction(): string

public getDefaultController(): string

public getDefaultModule(): string

public static getInstance(): Yaf_Dispatcher

public getRequest(): Yaf_Request_Abstract

public getRouter(): Yaf_Router

public initView(string $templates_dir, array $options = ?): Yaf_View_Interface

public registerPlugin(Yaf_Plugin_Abstract $plugin): Yaf_Dispatcher

public returnResponse(bool $flag): Yaf_Dispatcher

public setDefaultAction(string $action): Yaf_Dispatcher

public setDefaultController(string $controller): Yaf_Dispatcher

public setDefaultModule(string $module): Yaf_Dispatcher

public setErrorHandler(call $callback, int $error_types): Yaf_Dispatcher

public setRequest(Yaf_Request_Abstract $request): Yaf_Dispatcher

public setView(Yaf_View_Interface $view): Yaf_Dispatcher

public throwException(bool $flag = ?): Yaf_Dispatcher

}

プロパティ

_router
_view
_request
_plugins
_instance
_auto_render
_return_response
_instantly_flush
_default_module
_default_controller
_default_action

Yaf_Dispatcher::autoRender — 自動レンダリングのオン/オフを切り替える
Yaf_Dispatcher::catchException — 例外のキャッチのオン/オフを切り替える
Yaf_Dispatcher::__construct — Yaf_Dispatcher のコンストラクタ
Yaf_Dispatcher::disableView — ビューのレンダリングを無効にする
Yaf_Dispatcher::dispatch — リクエストをディスパッチする
Yaf_Dispatcher::enableView — ビューのレンダリングを有効にする
Yaf_Dispatcher::flushInstantly — その場でのフラッシュのオン/オフを切り替える
Yaf_Dispatcher::getApplication — アプリケーションを取得する
Yaf_Dispatcher::getDefaultAction — Retrive the default action name
Yaf_Dispatcher::getDefaultController — Retrive the default controller name
Yaf_Dispatcher::getDefaultModule — Retrive the default module name
Yaf_Dispatcher::getInstance — ディスパッチャのインスタンスを取得する
Yaf_Dispatcher::getRequest — リクエストのインスタンスを取得する
Yaf_Dispatcher::getRouter — ルーターのインスタンスを取得する
Yaf_Dispatcher::initView — ビューを初期化して返す
Yaf_Dispatcher::registerPlugin — プラグインを登録する
Yaf_Dispatcher::returnResponse — The returnResponse purpose
Yaf_Dispatcher::setDefaultAction — デフォルトのアクション名を変更する
Yaf_Dispatcher::setDefaultController — デフォルトのコントローラ名を変更する
Yaf_Dispatcher::setDefaultModule — デフォルトのモジュール名を変更する
Yaf_Dispatcher::setErrorHandler — エラーハンドラを設定する
Yaf_Dispatcher::setRequest — The setRequest purpose
Yaf_Dispatcher::setView — カスタムビューエンジンを設定する
Yaf_Dispatcher::throwException — 例外のスローのオン/オフを切り替える

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.