Docs For Class Setuco_Controller_Action_Abstract

Setuco

# Class: Setuco_Controller_Action_Abstract Source Location: /library/Setuco/Controller/Action/Abstract.php
### Class Overview
    Zend_Controller_Action
       |
       --Setuco_Controller_Action_Abstract
#### Author(s): suzuki-mar | ### Variables $_pageLimit | ### Constants DOT_ADDITIONAL_STRING | ### Methods init setPagerForView _encodeRestParam _getModulePath _getPageLimit _getPageNumber _initLayout _isRedirectNeeded _loadRedirectParams _restRedirectIfNeeded _setLayoutName _setPageLimit _showFlashMessages
### Child classes: Admin_LoginController ログイン処理をするコントローラ Setuco_Controller_Action_AdminAbstract Setuco_Controller_Action_DefaultAbstract Setuco_Controller_Action_ErrorAbstract
### Class Details [line 26] #### Tags:
author: | suzuki-mar
abstract: |
[ Top ] ### Class Variables #### $_pageLimit = null [line 33] 一覧ページで、1ページあたり何件のデータを表示するか #### Tags:
access: | protected
Type: | null
[ Top ] ### Class Methods ### method init [line 48]
`void init( )`
全てのコントローラ共通の初期処理です。 #### Tags:
author: | suzuki-mar charlesvineyard
access: | public
Overridden in child classes as: Admin_LoginController::init() 初期化処理 Setuco_Controller_Action_AdminAbstract::init() adminモジュールコントローラの初期処理です。 Admin_AccountController::init() Admin_CategoryController::init() コントローラーの共通設定をする 全アクションで使用するサービスクラスのインスタンスをオブジェクト変数にする Admin_DirectoryController::init() 初期処理 Admin_IndexController::init() 初期処理 Admin_MediaController::init() 初期化処理 Admin_PageController::init() 初期処理 Admin_SiteController::init() クラス変数の設定をする Admin_TagController::init() 初期処理 Setuco_Controller_Action_DefaultAbstract::init() defaultモジュールコントローラの初期処理です。 IndexController::init() アクションの共通設定 PageController::init() アクションの共通設定 [ Top ] ### method setPagerForView [line 251]
`void setPagerForView( int $max, [int[option] $limit = null])`
ページャーの設定をして、ビューで使用できるようにする #### Tags:
author: | suzuki-mar
access: | public
#### Parameters:
int | $max | 最大何件のデータが該当したのか
int[option] | $limit | 一ページあたりに何件のデータを表示するのか
[ Top ] ### method _encodeRestParam [line 191]
`string _encodeRestParam( string $param)`
パラメーターをリダイレクトパラムで確実に送信出来るようにエンコードします。 #### Tags:
return: | エンコード後のパラメーター
author: | charlesvineyard
access: | private
#### Parameters:
string | $param | エンコードするパラメーター
[ Top ] ### method _getModulePath [line 238]
`String _getModulePath( )`
モジュールのディレクトリーのパスを取得する #### Tags:
return: | モジュールのディレクトリーのパス
author: | suzuki_mar
access: | protected
[ Top ] ### method _getPageLimit [line 310]
`int _getPageLimit( )`
一ページあたりの取得件数の_pageLimitのゲッター #### Tags:
return: | 一ページあたりの取得件数
author: | suzuki-mar
access: | protected
[ Top ] ### method _getPageNumber [line 293]
`int _getPageNumber( )`
ページネーターで使う現在の（クリックされた）ページ番号を取得するメソッドです #### Tags:
return: | 現在ページネーターで表示すべきページ番号
author: | akitsukada suzuki-mar
access: | protected
[ Top ] ### method _initLayout [line 211]
`void _initLayout( )`
レイアウトを設定します。 #### Tags:
author: | suzuki_mar charlesvineyard
access: | protected
Overridden in child classes as: Setuco_Controller_Action_ErrorAbstract::_initLayout() レイアウトを設定します。 [ Top ] ### method _isRedirectNeeded [line 145]
`bool _isRedirectNeeded( $restParamConfigs, array $redirectParams)`
REST形式のURLにリダイレクトするかどうか判断します。 #### Tags:
return: | リダイレクトする場合は true。しない場合はfalse。
author: | suzuki_mar charlesvineyard
access: | private
#### Parameters:
array | $redirectParams | リダイレクトするパラメーター配列
| $restParamConfigs |
[ Top ] ### method _loadRedirectParams [line 69]
`array _loadRedirectParams( )`
REST形式にリダイレクトするパラメーターを取得する ファイル名は rest-params.xml #### Tags:
return: | REST形式にリダイレクトするパラメーター
author: | suzuki-mar
access: | protected
[ Top ] ### method _restRedirectIfNeeded [line 106]
`mixed _restRedirectIfNeeded( array $restParamConfigs)`
REST形式のURLにリダイレクトするものだったら、リダイレクトする #### Tags:
return: | リダイレクトする場合はvoid しない場合はfalse
author: | suzuki-mar
access: | protected
#### Parameters:
array | $restParamConfigs | リダイレクトするパラメーター配列
[ Top ] ### method _setLayoutName [line 227]
`void _setLayoutName( $layoutName)`
レイアウト名を設定します。 レイアウト名はレイアウトファイルの拡張子無しのファイル名です。 #### Tags:
author: | charlesvineyard
access: | protected
#### Parameters:
| $layoutName |
[ Top ] ### method _setPageLimit [line 324]
`$this _setPageLimit( $pageLimit, int $limitPage)`
一ページあたりの取得件数の_pageLimitのセッター メソッドチェーンを使用できる #### Tags:
return: | 自分自身のインスタンス
author: | suzuki-mar
access: | protected
#### Parameters:
int | $limitPage | 1ページあたりの取得件数
| $pageLimit |
[ Top ] ### method _showFlashMessages [line 337]
`void _showFlashMessages( [string $paramName = 'flashMessages'])`
フラッシュメッセージがアクションヘルパーに設定されていればビューにセットして可視化します。 #### Tags:
author: | charlesvineyard
access: | protected
#### Parameters:
string | $paramName | ビューにセットする変数名。デフォルトは "flashMessage"。
[ Top ] ### Class Constants #### DOT_ADDITIONAL_STRING = '%^' [line 40] RESTリダイレクトのときにパラメーターのドットに付加する文字列 [ Top ] Documentation generated on Mon, 07 Feb 2011 01:28:03 +0900 by phpDocumentor 1.4.3