Docs For Class Setuco_Controller_Action_AdminAbstract

Setuco

# Class: Setuco_Controller_Action_AdminAbstract Source Location: /library/Setuco/Controller/Action/AdminAbstract.php
### Class Overview
    Zend_Controller_Action
       |
       --Setuco_Controller_Action_Abstract
          |
          --Setuco_Controller_Action_AdminAbstract
#### Author(s): suzuki-mar | ### Variables $_navigation $_pageLimit $_pageTitle | ### Constants PAGE_LIMIT | ### Methods init postDispatch _addFormElementCommonOptions _chooseHeadTitle _getAccountInfos _initHeader _initNavigation
### Child classes: Admin_AccountController Admin_CategoryController Admin_DirectoryController サイト構造一覧のコントローラ Admin_IndexController 管理側のTOPページのコントローラ Admin_MediaController ファイル管理画面の操作を行うコントローラ Admin_NavigationController ナビゲーションのコントローラ Admin_PageController Admin_SiteController Admin_TagController タグ管理のコントローラ | ### Inherited Constants #### Class: Setuco_Controller_Action_Abstract Setuco_Controller_Action_Abstract::DOT_ADDITIONAL_STRING | ### Inherited Methods #### Class: Setuco_Controller_Action_Abstract Setuco_Controller_Action_Abstract::init() 全てのコントローラ共通の初期処理です。 Setuco_Controller_Action_Abstract::setPagerForView() ページャーの設定をして、ビューで使用できるようにする Setuco_Controller_Action_Abstract::_encodeRestParam() パラメーターをリダイレクトパラムで確実に送信出来るようにエンコードします。 Setuco_Controller_Action_Abstract::_getModulePath() モジュールのディレクトリーのパスを取得する Setuco_Controller_Action_Abstract::_getPageLimit() 一ページあたりの取得件数の_pageLimitのゲッター Setuco_Controller_Action_Abstract::_getPageNumber() ページネーターで使う現在の（クリックされた）ページ番号を取得するメソッドです Setuco_Controller_Action_Abstract::_initLayout() レイアウトを設定します。 Setuco_Controller_Action_Abstract::_isRedirectNeeded() REST形式のURLにリダイレクトするかどうか判断します。 Setuco_Controller_Action_Abstract::_loadRedirectParams() REST形式にリダイレクトするパラメーターを取得する ファイル名は rest-params.xml Setuco_Controller_Action_Abstract::_restRedirectIfNeeded() REST形式のURLにリダイレクトするものだったら、リダイレクトする Setuco_Controller_Action_Abstract::_setLayoutName() レイアウト名を設定します。 Setuco_Controller_Action_Abstract::_setPageLimit() 一ページあたりの取得件数の_pageLimitのセッター メソッドチェーンを使用できる Setuco_Controller_Action_Abstract::_showFlashMessages() フラッシュメッセージがアクションヘルパーに設定されていればビューにセットして可視化します。
### Class Details [line 23] #### Tags:
author: | suzuki-mar
abstract: |
[ Top ] ### Class Variables #### $_navigation = [line 38] ナビゲーション #### Tags:
access: | protected
Type: | Zend_Navigation
[ Top ] #### $_pageLimit = 10 [line 51] 一覧ページで、1ページあたり何件のデータを表示するか #### Tags:
todo: | PAGE_LIMITの削除
access: | protected
Type: | int
Overrides: | Array
[ Top ] #### $_pageTitle = [line 31] ページのタイトル 設定ファイルからとれないときだけ指定。 #### Tags:
access: | protected
Type: | string
[ Top ] ### Class Methods ### method init [line 60]
`void init( )`
adminモジュールコントローラの初期処理です。 #### Tags:
author: | suzuki-mar
access: | public
Overridden in child classes as: Admin_AccountController::init() Admin_CategoryController::init() コントローラーの共通設定をする 全アクションで使用するサービスクラスのインスタンスをオブジェクト変数にする Admin_DirectoryController::init() 初期処理 Admin_IndexController::init() 初期処理 Admin_MediaController::init() 初期化処理 Admin_PageController::init() 初期処理 Admin_SiteController::init() クラス変数の設定をする Admin_TagController::init() 初期処理 Overrides Setuco_Controller_Action_Abstract::init() (全てのコントローラ共通の初期処理です。) [ Top ] ### method postDispatch [line 110]
`void postDispatch( )`
アクションメソッドが呼ばれた後の処理です。 #### Tags:
author: | charlesvineyard
access: | public
[ Top ] ### method _addFormElementCommonOptions [line 150]
`void _addFormElementCommonOptions( &$element, [array[option] $cancelOptions = null], Zend_Form_Element $element　共通の設定をするフォームエレメントクラス)`
フォームエレメントの共通設定をする requiredなどの設定をする 　第２引数で、設定しない項目を指定できる #### Tags:
author: | suzuki-mar
access: | protected
#### Parameters:
Zend_Form_Element | $element　共通の設定をするフォームエレメントクラス |
array[option] | $cancelOptions | キャンセル名前のキーにfalseを渡すと設定しないことができる
| &$element |
[ Top ] ### method _chooseHeadTitle [line 124]
`string|null _chooseHeadTitle( )`
リクエスト中のページのタイトルを取得します。 #### Tags:
return: | タイトルが設定されていればタイトル、なければ null を返します。
author: | charlesvineyard
access: | protected
[ Top ] ### method _getAccountInfos [line 166]
`array _getAccountInfos( [string[option] $columnName = null])`
ログインしているユーザーの情報を取得する #### Tags:
return: | ユーザーの情報
author: | suzuki-mar
access: | protected
#### Parameters:
string[option] | $columnName | 取得するカラム　指定がない場合はすべて取得する
[ Top ] ### method _initHeader [line 88]
`Zend_Navigation _initHeader( )`
ヘッダーに関する初期処理です。 #### Tags:
author: | charlesvineyard suzuki-mar
access: | protected
[ Top ] ### method _initNavigation [line 75]
`Zend_Navigation _initNavigation( )`
ナビゲーションの設定情報を初期化します。 #### Tags:
author: | charlesvineyard
access: | protected
[ Top ] ### Class Constants #### PAGE_LIMIT = 10 [line 44] 一覧ページで、1ページあたり何件のデータを表示するか 削除するので使用しない #### Tags:
todo: | 定数の削除 検討課題のチケットチェック時に削除する
[ Top ] Documentation generated on Mon, 07 Feb 2011 01:28:05 +0900 by phpDocumentor 1.4.3