# Yet Another Framework (Yaf)

# はじめに

`Yet Another Framework`(Yaf) 拡張モジュールは PHP のフレームワークで、ウェブアプリケーションの開発に使います。

ちょっとした Yaf のベンチマークが » Yaf Performance にあります。

手っ取り早く使い始めるには、チュートリアルを参照ください。

- インストール/設定
  - インストール手順
  - 実行時設定
- 定義済み定数
- 例
- アプリケーションの設定
- Yaf_Application — Yaf_Application クラス
  - Yaf_Application::app — アプリケーションのインスタンスを取得する
  - Yaf_Application::bootstrap — ブートストラップをコールする
  - Yaf_Application::clearLastError — 直近のエラー情報を消す
  - Yaf_Application::__construct — Yaf_Application のコンストラクタ
  - Yaf_Application::__destruct — デストラクタ
  - Yaf_Application::environ — 環境を取得する
  - Yaf_Application::execute — コールバックを実行する
  - Yaf_Application::getAppDirectory — アプリケーションディレクトリを取得する
  - Yaf_Application::getConfig — 設定情報を取得する
  - Yaf_Application::getDispatcher — Yaf_Dispatcher のインスタンスを取得する
  - Yaf_Application::getLastErrorMsg — 直近で発生したエラーのメッセージを取得する
  - Yaf_Application::getLastErrorNo — 直近で発生したエラーのコードを取得する
  - Yaf_Application::getModules — 定義済みのモジュール名を取得する
  - Yaf_Application::run — Yaf_Application を開始する
  - Yaf_Application::setAppDirectory — アプリケーションディレクトリを変更する
- Yaf_Bootstrap_Abstract — Yaf_Bootstrap_Abstract クラス
- Yaf_Dispatcher — Yaf_Dispatcher クラス
  - 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 — 例外のスローのオン/オフを切り替える
- Yaf_Config_Abstract — Yaf_Config_Abstract クラス
  - Yaf_Config_Abstract::get — ゲッター
  - Yaf_Config_Abstract::readonly — 設定項目が読み込み専用かどうかを調べる
  - Yaf_Config_Abstract::set — セッター
  - Yaf_Config_Abstract::toArray — 配列に変換する
- Yaf_Config_Ini — Yaf_Config_Ini クラス
  - Yaf_Config_Ini::__construct — Yaf_Config_Ini のコンストラクタ
  - Yaf_Config_Ini::count — Yaf_Config.ini の全ての要素を数える
  - Yaf_Config_Ini::current — 現在の値を取得する
  - Yaf_Config_Ini::__get — 要素を取得する
  - Yaf_Config_Ini::__isset — キーが存在するかを判定する
  - Yaf_Config_Ini::key — 現在の要素のキーを取得する
  - Yaf_Config_Ini::next — 内部ポインタを進める
  - Yaf_Config_Ini::offsetExists — The offsetExists purpose
  - Yaf_Config_Ini::offsetGet — The offsetGet purpose
  - Yaf_Config_Ini::offsetSet — The offsetSet purpose
  - Yaf_Config_Ini::offsetUnset — The offsetUnset purpose
  - Yaf_Config_Ini::readonly — The readonly purpose
  - Yaf_Config_Ini::rewind — The rewind purpose
  - Yaf_Config_Ini::__set — The __set purpose
  - Yaf_Config_Ini::toArray — PHP の配列として構成を返す
  - Yaf_Config_Ini::valid — The valid purpose
- Yaf_Config_Simple — Yaf_Config_Simple クラス
  - Yaf_Config_Simple::__construct — コンストラクタ
  - Yaf_Config_Simple::count — The count purpose
  - Yaf_Config_Simple::current — The current purpose
  - Yaf_Config_Simple::__get — The __get purpose
  - Yaf_Config_Simple::__isset — The __isset purpose
  - Yaf_Config_Simple::key — The key purpose
  - Yaf_Config_Simple::next — The next purpose
  - Yaf_Config_Simple::offsetExists — The offsetExists purpose
  - Yaf_Config_Simple::offsetGet — The offsetGet purpose
  - Yaf_Config_Simple::offsetSet — The offsetSet purpose
  - Yaf_Config_Simple::offsetUnset — The offsetUnset purpose
  - Yaf_Config_Simple::readonly — The readonly purpose
  - Yaf_Config_Simple::rewind — The rewind purpose
  - Yaf_Config_Simple::__set — The __set purpose
  - Yaf_Config_Simple::toArray — PHP の配列を返す
  - Yaf_Config_Simple::valid — The valid purpose
- Yaf_Controller_Abstract — Yaf_Controller_Abstract クラス
  - Yaf_Controller_Abstract::__construct — Yaf_Controller_Abstract のコンストラクタ
  - Yaf_Controller_Abstract::display — The display purpose
  - Yaf_Controller_Abstract::forward — 別のアクションに転送する
  - Yaf_Controller_Abstract::getInvokeArg — The getInvokeArg purpose
  - Yaf_Controller_Abstract::getInvokeArgs — The getInvokeArgs purpose
  - Yaf_Controller_Abstract::getModuleName — モジュール名を取得する
  - Yaf_Controller_Abstract::getName — Get self name
  - Yaf_Controller_Abstract::getRequest — 現在のリクエストオブジェクトを取得する
  - Yaf_Controller_Abstract::getResponse — 現在のレスポンスオブジェクトを取得する
  - Yaf_Controller_Abstract::getView — ビューエンジンを取得する
  - Yaf_Controller_Abstract::getViewpath — getViewpath の目的を書く
  - Yaf_Controller_Abstract::init — コントローラを初期化する
  - Yaf_Controller_Abstract::initView — The initView purpose
  - Yaf_Controller_Abstract::redirect — URL にリダイレクトする
  - Yaf_Controller_Abstract::render — ビューテンプレートをレンダリングする
  - Yaf_Controller_Abstract::setViewpath — The setViewpath purpose
- Yaf_Action_Abstract — Yaf_Action_Abstract クラス
  - Yaf_Action_Abstract::execute — アクションのエントリポイント
  - Yaf_Action_Abstract::getController — コントローラオブジェクトを取得する
  - Yaf_Action_Abstract::getControllerName — Get controller name
- Yaf_View_Interface — Yaf_View_Interface クラス
  - Yaf_View_Interface::assign — 値をビューエンジンに代入する
  - Yaf_View_Interface::display — テンプレートをレンダリングして出力する
  - Yaf_View_Interface::getScriptPath — The getScriptPath purpose
  - Yaf_View_Interface::render — テンプレートをレンダリングする
  - Yaf_View_Interface::setScriptPath — The setScriptPath purpose
- Yaf_View_Simple — Yaf_View_Simple クラス
  - Yaf_View_Simple::assign — 値を代入する
  - Yaf_View_Simple::assignRef — The assignRef purpose
  - Yaf_View_Simple::clear — 代入した値をクリアする
  - Yaf_View_Simple::__construct — Yaf_View_Simple のコンストラクタ
  - Yaf_View_Simple::display — レンダリングして表示する
  - Yaf_View_Simple::eval — テンプレートをレンダリングする
  - Yaf_View_Simple::__get — Retrieve assigned variable
  - Yaf_View_Simple::getScriptPath — テンプレートのディレクトリを取得する
  - Yaf_View_Simple::__isset — The __isset purpose
  - Yaf_View_Simple::render — テンプレートをレンダリングする
  - Yaf_View_Simple::__set — 値をエンジンに設定する
  - Yaf_View_Simple::setScriptPath — テンプレートのディレクトリを設定する
- Yaf_Loader — Yaf_Loader クラス
  - Yaf_Loader::autoload — The autoload purpose
  - Yaf_Loader::clearLocalNamespace — The clearLocalNamespace purpose
  - Yaf_Loader::__construct — The __construct purpose
  - Yaf_Loader::getInstance — The getInstance purpose
  - Yaf_Loader::getLibraryPath — ライブラリパスを取得する
  - Yaf_Loader::getLocalNamespace — The getLocalNamespace purpose
  - Yaf_Loader::getNamespacePath — Retieve path of a registered namespace
  - Yaf_Loader::getLocalNamespace — Retrive all register namespaces info
  - Yaf_Loader::import — The import purpose
  - Yaf_Loader::isLocalName — The isLocalName purpose
  - Yaf_Loader::registerLocalNamespace — ローカルクラスプレフィックスを登録する
  - Yaf_Loader::registerNamespace — Register namespace with searching path
  - Yaf_Loader::setLibraryPath — ライブラリパスを変更する
- Yaf_Plugin_Abstract — Yaf_Plugin_Abstract クラス
  - Yaf_Plugin_Abstract::dispatchLoopShutdown — The dispatchLoopShutdown purpose
  - Yaf_Plugin_Abstract::dispatchLoopStartup — ディスパッチループの前にフックする
  - Yaf_Plugin_Abstract::postDispatch — The postDispatch purpose
  - Yaf_Plugin_Abstract::preDispatch — The preDispatch purpose
  - Yaf_Plugin_Abstract::preResponse — The preResponse purpose
  - Yaf_Plugin_Abstract::routerShutdown — The routerShutdown purpose
  - Yaf_Plugin_Abstract::routerStartup — RouterStartup フック
- Yaf_Registry — Yaf_Registry クラス
  - Yaf_Registry::__construct — Yaf_Registry はシングルトンを実装する
  - Yaf_Registry::del — アイテムをレジストリから削除する
  - Yaf_Registry::get — アイテムをレジストリから取得する
  - Yaf_Registry::has — アイテムが存在するかどうかを調べる
  - Yaf_Registry::set — アイテムをレジストリに追加する
- Yaf_Request_Abstract — Yaf_Request_Abstract クラス
  - Yaf_Request_Abstract::clearParams — Remove all params
  - Yaf_Request_Abstract::getActionName — The getActionName purpose
  - Yaf_Request_Abstract::getBaseUri — The getBaseUri purpose
  - Yaf_Request_Abstract::getControllerName — The getControllerName purpose
  - Yaf_Request_Abstract::getEnv — ENV 変数を取得する
  - Yaf_Request_Abstract::getException — The getException purpose
  - Yaf_Request_Abstract::getLanguage — クライアントの好きな言語を取得する
  - Yaf_Request_Abstract::getMethod — リクエストメソッドを取得する
  - Yaf_Request_Abstract::getModuleName — The getModuleName purpose
  - Yaf_Request_Abstract::getParam — 呼び出しパラメータを取得する
  - Yaf_Request_Abstract::getParams — 全ての呼び出しパラメータを取得する
  - Yaf_Request_Abstract::getRequestUri — The getRequestUri purpose
  - Yaf_Request_Abstract::getServer — SERVER 変数を取得する
  - Yaf_Request_Abstract::isCli — CLIリクエストかを判定する
  - Yaf_Request_Abstract::isDispatched — リクエストがディスパッチ済みかを判定する
  - Yaf_Request_Abstract::isGet — GETリクエストかどうかを判定する
  - Yaf_Request_Abstract::isHead — HEADリクエストかどうかを判定する
  - Yaf_Request_Abstract::isOptions — OPTIONS リクエストかどうかを判定する
  - Yaf_Request_Abstract::isPost — POST リクエストかどうかを判定する
  - Yaf_Request_Abstract::isPut — PUTリクエストかどうかを判定する
  - Yaf_Request_Abstract::isRouted — リクエストがルーティング済みかを判定する
  - Yaf_Request_Abstract::isXmlHttpRequest — AJAXリクエストかどうかを判定する
  - Yaf_Request_Abstract::setActionName — アクション名を設定する
  - Yaf_Request_Abstract::setBaseUri — ベース URI を設定する
  - Yaf_Request_Abstract::setControllerName — コントローラー名を設定する
  - Yaf_Request_Abstract::setDispatched — The setDispatched purpose
  - Yaf_Request_Abstract::setModuleName — モジュール名を設定する
  - Yaf_Request_Abstract::setParam — 呼び出しパラメータをリクエストに設定する
  - Yaf_Request_Abstract::setRequestUri — The setRequestUri purpose
  - Yaf_Request_Abstract::setRouted — The setRouted purpose
- Yaf_Request_Http — Yaf_Request_Http クラス
  - Yaf_Request_Http::__construct — Yaf_Request_Http のコンストラクタ
  - Yaf_Request_Http::get — クライアントからの変数を取得する
  - Yaf_Request_Http::getCookie — Cookie 変数を取得する
  - Yaf_Request_Http::getFiles — The getFiles purpose
  - Yaf_Request_Http::getPost — POST 変数を取得する
  - Yaf_Request_Http::getQuery — クエリパラメータを取得する
  - Yaf_Request_Http::getRaw — 生のリクエストボディを取得する
  - Yaf_Request_Http::getRequest — The getRequest purpose
  - Yaf_Request_Http::isXmlHttpRequest — リクエストが Ajax リクエストかどうかを判断する
- Yaf_Request_Simple — Yaf_Request_Simple クラス
  - Yaf_Request_Simple::__construct — Yaf_Request_Simple のコンストラクタ
  - Yaf_Request_Simple::get — The get purpose
  - Yaf_Request_Simple::getCookie — The getCookie purpose
  - Yaf_Request_Simple::getFiles — The getFiles purpose
  - Yaf_Request_Simple::getPost — The getPost purpose
  - Yaf_Request_Simple::getQuery — The getQuery purpose
  - Yaf_Request_Simple::getRequest — The getRequest purpose
  - Yaf_Request_Simple::isXmlHttpRequest — リクエストが AJAX 経由のリクエストかどうかを判定する
- Yaf_Response_Abstract — Yaf_Response_Abstract クラス
  - Yaf_Response_Abstract::appendBody — レスポンス本文に追記する
  - Yaf_Response_Abstract::clearBody — 既存のすべてのレスポンス本文を破棄します
  - Yaf_Response_Abstract::clearHeaders — すべてのヘッダをクリアする
  - Yaf_Response_Abstract::__construct — The __construct purpose
  - Yaf_Response_Abstract::__destruct — The __destruct purpose
  - Yaf_Response_Abstract::getBody — コンテンツを取得する
  - Yaf_Response_Abstract::getHeader — getHeader の目的
  - Yaf_Response_Abstract::prependBody — The prependBody purpose
  - Yaf_Response_Abstract::response — レスポンスを送信する
  - Yaf_Response_Abstract::setAllHeaders — The setAllHeaders purpose
  - Yaf_Response_Abstract::setBody — コンテンツをレスポンスに設定する
  - Yaf_Response_Abstract::setHeader — レスポンスヘッダを設定する
  - Yaf_Response_Abstract::setRedirect — The setRedirect purpose
  - Yaf_Response_Abstract::__toString — すべてのレスポンスボディを文字列として取得する
- Yaf_Route_Interface — Yaf_Route_Interface クラス
  - Yaf_Route_Interface::assemble — リクエストを組み立てる
  - Yaf_Route_Interface::route — リクエストをルーティングする
- Yaf_Route_Map — Yaf_Route_Map クラス
  - Yaf_Route_Map::assemble — URLを組み立てる
  - Yaf_Route_Map::__construct — The __construct purpose
  - Yaf_Route_Map::route — route の目的
- Yaf_Route_Regex — Yaf_Route_Regex クラス
  - Yaf_Route_Regex::assemble — URL を組み立てる
  - Yaf_Route_Regex::__construct — Yaf_Route_Regex のコンストラクタ
  - Yaf_Route_Regex::route — The route purpose
- Yaf_Route_Rewrite — Yaf_Route_Rewrite クラス
  - Yaf_Route_Rewrite::assemble — URLを組み立てる
  - Yaf_Route_Rewrite::__construct — Yaf_Route_Rewrite のコンストラクタ
  - Yaf_Route_Rewrite::route — The route purpose
- Yaf_Router — Yaf_Router クラス
  - Yaf_Router::addConfig — 設定で定義したルートをルーターに追加する
  - Yaf_Router::addRoute — 新しいルートをルーターに追加する
  - Yaf_Router::__construct — Yaf_Router のコンストラクタ
  - Yaf_Router::getCurrentRoute — 使われているルート名を取得する
  - Yaf_Router::getRoute — 名前を指定してルートを取得する
  - Yaf_Router::getRoutes — 登録済みのルートを取得する
  - Yaf_Router::route — The route purpose
- Yaf_Route_Simple — Yaf_Route_Simple クラス
  - Yaf_Route_Simple::assemble — URLを組み立てる
  - Yaf_Route_Simple::__construct — Yaf_Route_Simple のコンストラクタ
  - Yaf_Route_Simple::route — リクエストをルーティングする
- Yaf_Route_Static — Yaf_Route_Static クラス
  - Yaf_Route_Static::assemble — URL を組み立てる
  - Yaf_Route_Static::match — The match purpose
  - Yaf_Route_Static::route — リクエストをルーティングする
- Yaf_Route_Supervar — Yaf_Route_Supervar クラス
  - Yaf_Route_Supervar::assemble — URL を組み立てる
  - Yaf_Route_Supervar::__construct — The __construct purpose
  - Yaf_Route_Supervar::route — The route purpose
- Yaf_Session — Yaf_Session クラス
  - Yaf_Session::__construct — Yaf_Session のコンストラクタ
  - Yaf_Session::count — The count purpose
  - Yaf_Session::current — The current purpose
  - Yaf_Session::del — The del purpose
  - Yaf_Session::__get — The __get purpose
  - Yaf_Session::getInstance — The getInstance purpose
  - Yaf_Session::has — The has purpose
  - Yaf_Session::__isset — The __isset purpose
  - Yaf_Session::key — The key purpose
  - Yaf_Session::next — The next purpose
  - Yaf_Session::offsetExists — The offsetExists purpose
  - Yaf_Session::offsetGet — The offsetGet purpose
  - Yaf_Session::offsetSet — The offsetSet purpose
  - Yaf_Session::offsetUnset — The offsetUnset purpose
  - Yaf_Session::rewind — The rewind purpose
  - Yaf_Session::__set — The __set purpose
  - Yaf_Session::start — The start purpose
  - Yaf_Session::__unset — The __unset purpose
  - Yaf_Session::valid — The valid purpose
- Yaf_Exception — Yaf_Exception クラス
  - Yaf_Exception::__construct — コンストラクタ
  - Yaf_Exception::getPrevious — The getPrevious purpose
- Yaf_Exception_TypeError — Yaf_Exception_TypeError クラス
- Yaf_Exception_StartupError — Yaf_Exception_StartupError クラス
- Yaf_Exception_DispatchFailed — Yaf_Exception_DispatchFailed クラス
- Yaf_Exception_RouterFailed — Yaf_Exception_RouterFailed クラス
- Yaf_Exception_LoadFailed — Yaf_Exception_LoadFailed クラス
- Yaf_Exception_LoadFailed_Module — Yaf_Exception_LoadFailed_Module クラス
- Yaf_Exception_LoadFailed_Controller — Yaf_Exception_LoadFailed_Controller クラス
- Yaf_Exception_LoadFailed_Action — Yaf_Exception_LoadFailed_Action クラス
- Yaf_Exception_LoadFailed_View — Yaf_Exception_LoadFailed_View クラス

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open