Docs For Class Ethna

Ethna_ViewClass

Description

viewクラス

author: Masaki Fujimoto <fujimoto@php.net>
access: public

Located in /class/ViewClass.php (line 20)

Direct descendents

Class	Description
Ethna_View_404	404ページ(リソースが存在しない場合のエラーページ) を出力するビューの実装
Ethna_View_403	403ページ(アクセスを禁止することを知らせるページ) を出力するビューの実装
Ethna_View_UnitTest	__ethna_unittest__ビューの実装
Ethna_View_List	リストビュー基底クラスの実装
Ethna_View_500	500ページ(内部エラーが起きた場合のエラーページ) を出力するビューの実装
Ethna_View_Redirect	別のURLへリダイレクトするためのビューの実装
Ethna_View_Json	JSON を出力するビューの実装
Ethna_View_Info	__ethna_info__ビューの実装

Variable Summary

mixed $action_error

mixed $action_form

mixed $ae

mixed $af

mixed $backend

mixed $config

mixed $ctl

array $default_header

mixed $forward_name

mixed $forward_path

mixed $has_default_header

mixed $helper_action_form

mixed $helper_parameter_keys

mixed $i18n

mixed $logger

mixed $plugin

mixed $reset_counter

mixed $session

boolean $use_layout

string $_layout_file

Method Summary

Ethna_ViewClass __construct (object Ethna_Backend $backend, string $forward_name, string $forward_path)

void addActionFormHelper (string $action, [boolean $dynamic_helper = false])

void clearActionFormHelper ( $action)

void error (int $code)

void forward ()

void getCurrentForwardName ()

void getFormBlock ( $content, $params)

void getFormInput ( $name, $action, $params)

void getFormName ( $name, $action, $params)

void getFormSubmit ( $params)

string getLayout ()

void header (mixed $status)

void preforward (mixed $params)

void redirect (string $url, [int $staus_code = 302])

void resetFormCounter ()

void setLayout (string $filename)

boolean templateExists (string $filename)

void _getFormInput_Button ( $name, $def, $params)

void _getFormInput_Checkbox ( $name, $def, $params)

void _getFormInput_File ( $name, $def, $params)

void _getFormInput_Hidden ( $name, $def, $params)

void _getFormInput_Html ( $tag, $attr, [ $element = null], [ $escape_element = true])

void _getFormInput_Password ( $name, $def, $params)

void _getFormInput_Radio ( $name, $def, $params)

void _getFormInput_Select ( $name, $def, $params)

void _getFormInput_Submit ( $name, $def, $params)

void _getFormInput_Text ( $name, $def, $params)

void _getFormInput_Textarea ( $name, $def, $params)

object Ethna_ActionFormまたは継承オブジェクト _getHelperActionForm ([string $action = null], [string $name = null])

object Ethna_Renderer _getRenderer ()

void _getSelectorOptions ( $af, $def, $params)

void _setDefault (object Ethna_Renderer $renderer)

Variables

mixed $action_error (line 45)

access: protected

mixed $action_form (line 51)

access: protected

mixed $ae (line 48)

access: protected

mixed $af (line 54)

access: protected

mixed $backend (line 30)

access: protected

mixed $config (line 33)

access: protected

mixed $ctl (line 27)

access: protected

array $default_header = array(
'Pragma' => 'no-cache',
'Cache-Control' => 'no-cache, no-store, must-revalidate',
) (line 97)

var: default header
access: public

mixed $forward_name (line 66)

access: public

mixed $forward_path (line 69)

access: protected

mixed $has_default_header = true (line 94)

ヘッダ出力を改造する場合はfalseにする

access: public

Redefined in descendants as:

Ethna_View_Json::$has_default_header

mixed $helper_action_form = array() (line 57)

access: protected

mixed $helper_parameter_keys = array('default', 'option', 'separator') (line 60)

access: protected

mixed $i18n (line 36)

access: protected

mixed $logger (line 39)

access: protected

mixed $plugin (line 42)

access: public

mixed $reset_counter = false (line 72)

access: protected

mixed $session (line 63)

access: protected

boolean $use_layout = true (line 90)

var: レイアウトテンプレートの使用フラグ
access: public

Redefined in descendants as:

string $_layout_file = 'layout' (line 81)

var: レイアウト(HTMLの外枠を記述するファイル)のテンプレートファイルを指定(拡張子は除く)
access: protected

Methods

Constructor __construct (line 111)

Ethna_ViewClassのコンストラクタ

access: public

Ethna_ViewClass __construct (object Ethna_Backend $backend, string $forward_name, string $forward_path)

object Ethna_Backend $backend: backendオブジェクト
string $forward_name: ビューに関連付けられている遷移名
string $forward_path: ビューに関連付けられているテンプレートファイル名

addActionFormHelper (line 398)

helperアクションフォームオブジェクトを設定する

access: public

void addActionFormHelper (string $action, [boolean $dynamic_helper = false])

string $action: アクション名
boolean $dynamic_helper: 動的フォームヘルパを呼ぶか否か

clearActionFormHelper (line 438)

helperアクションフォームオブジェクトを削除する

access: public

void clearActionFormHelper ( $action)

$action

error (line 380)

エラーページ出力用のHTTPステータスコードを指定します。

access: public

void error (int $code)

int $code: HTTPステータスコード

forward (line 164)

遷移名に対応する画面を出力する

特殊な画面を表示する場合を除いて特にオーバーライドする必要は無い (preforward()のみオーバーライドすれば良い)

access: public

void forward ()

Redefined in descendants as:

Ethna_View_Redirect::forward() : 遷移名に対応する画面を出力する
Ethna_View_Json::forward()

getCurrentForwardName (line 346)

getCurrentForwardName

access: public

void getCurrentForwardName ()

getFormBlock (line 641)

フォームタグを取得する(type="form")

access: public

void getFormBlock ( $content, $params)

$content
$params

getFormInput (line 552)

指定されたフォーム項目に対応するフォームタグを取得する

todo: JavaScript対応
access: public

void getFormInput ( $name, $action, $params)

$name
$action
$params

getFormName (line 513)

指定されたフォーム項目に対応するフォーム名(w/ レンダリング)を取得する

access: public

void getFormName ( $name, $action, $params)

$name
$action
$params

getFormSubmit (line 536)

submitボタンを取得する(送信先アクションで受け取るよう定義されていないときに、たんにsubmitボタンを作るのに使う)

access: public

void getFormSubmit ( $params)

$params

getLayout (line 334)

レイアウトテンプレートファイル名を取得します。

return: レイアウトテンプレートのファイル名
access: public

string getLayout ()

header (line 226)

HTTPヘッダを送信します。

access: public

void header (mixed $status)

mixed $status: ヘッダを設定する値配列指定の場合、header => value の形式整数指定の場合は、HTTPステータスコード文字列で指定する場合は、ヘッダ出力をそのまま指定

preforward (line 150)

画面表示前処理

テンプレートに設定する値でコンテキストに依存しないものはここで設定する(例:セレクトボックス等)

access: public

void preforward (mixed $params)

mixed $params: アクションクラスから返された引数 array('forward_name', $param) の形でアクションから値を返すことで、$params に値が渡されます。

Redefined in descendants as:

Ethna_View_404::preforward() : 404 ページを出力するための前処理を行う
Ethna_View_403::preforward() : 403 ページを出力するための前処理を行う
Ethna_View_UnitTest::preforward() : 遷移前処理
Ethna_View_List::preforward() : 遷移前処理
Ethna_View_500::preforward() : 500 ページを出力するための前処理を行う
Ethna_View_Redirect::preforward() : 別のURLへリダイレクトするための前処理を行う
Ethna_View_Json::preforward() : Jsonを出力する
Ethna_View_Info::preforward() : 遷移前処理

redirect (line 297)

リダイレクト処理

デフォルトのヘッダを送信しない
レイアウトテンプレートの使用をしない

access: public

void redirect (string $url, [int $staus_code = 302])

string $url: リダイレクト先(URL)
int $staus_code: HTTPステータスコード (3xx)

resetFormCounter (line 501)

フォームヘルパ用、内部フォームカウンタをリセットする

access: public

void resetFormCounter ()

setLayout (line 315)

レイアウトテンプレートのファイル名を設定します。レイアウトテンプレートは、HTML の外枠を設定するのに使用します。

access: public

void setLayout (string $filename)

string $filename: レイアウトファイル名

templateExists (line 361)

テンプレートファイルが存在するか否かを返します。

return: 指定したテンプレートファイルが存在すればtrue 存在しなければfalse
access: public

boolean templateExists (string $filename)

string $filename: チェック対象のテンプレートファイル

_getFormInput_Button (line 714)

フォームタグを取得する(type="button")

access: protected

void _getFormInput_Button ( $name, $def, $params)

$name
$def
$params

_getFormInput_Checkbox (line 742)

チェックボックスタグを取得する(type="check")

access: protected

void _getFormInput_Checkbox ( $name, $def, $params)

$name
$def
$params

_getFormInput_File (line 806)

フォームタグを取得する(type="file")

access: public

void _getFormInput_File ( $name, $def, $params)

$name
$def
$params

_getFormInput_Hidden (line 826)

フォームタグを取得する(type="hidden")

access: public

void _getFormInput_Hidden ( $name, $def, $params)

$name
$def
$params

_getFormInput_Html (line 1146)

HTMLタグを取得する

access: public

void _getFormInput_Html ( $tag, $attr, [ $element = null], [ $escape_element = true])

$tag
$attr
$element
$escape_element

_getFormInput_Password (line 864)

フォームタグを取得する(type="password")

access: public

void _getFormInput_Password ( $name, $def, $params)

$name
$def
$params

_getFormInput_Radio (line 905)

ラジオボタンタグを取得する(type="radio")

access: public

void _getFormInput_Radio ( $name, $def, $params)

$name
$def
$params

_getFormInput_Select (line 968)

セレクトボックスタグを取得する(type="select")

access: public

void _getFormInput_Select ( $name, $def, $params)

$name
$def
$params

_getFormInput_Submit (line 1040)

フォームタグを取得する(type="submit")

access: public

void _getFormInput_Submit ( $name, $def, $params)

$name
$def
$params

_getFormInput_Text (line 1102)

フォームタグを取得する(type="text")

access: public

void _getFormInput_Text ( $name, $def, $params)

$name
$def
$params

_getFormInput_Textarea (line 1067)

フォームタグを取得する(textarea)

access: public

void _getFormInput_Textarea ( $name, $def, $params)

$name
$def
$params

_getHelperActionForm (line 455)

アクションフォームオブジェクト(helper)を取得する $action === null で $name が指定されているときは、$nameの定義を含むものを探す

access: protected

object Ethna_ActionFormまたは継承オブジェクト _getHelperActionForm ([string $action = null], [string $name = null])

string $action: action 取得するアクション名
string $name: name 定義されていることを期待するフォーム名

_getRenderer (line 1182)

レンダラオブジェクトを取得する

return: レンダラオブジェクト
access: public

object Ethna_Renderer _getRenderer ()

_getSelectorOptions (line 658)

select, radio, checkbox の選択肢を取得する

access: protected

void _getSelectorOptions ( $af, $def, $params)

$af
$def
$params

_setDefault (line 1218)

共通値を設定する

access: protected

void _setDefault (object Ethna_Renderer $renderer)

object Ethna_Renderer $renderer: レンダラオブジェクト

Redefined in descendants as:

Ethna_View_Info::_setDefault()

Documentation generated on Fri, 11 Nov 2011 03:59:25 +0900 by phpDocumentor 1.4.3