Docs For Class Admin_CategoryController

Admin

# Class: Admin_CategoryController Source Location: /application/modules/admin/controllers/CategoryController.php
### Class Overview
    Zend_Controller_Action
       |
       --Setuco_Controller_Action_Abstract
          |
          --Setuco_Controller_Action_AdminAbstract
             |
             --Admin_CategoryController
#### Author(s): charlesvineyard suzuki-mar saniker10 | ### Variables $_categoryService $_deleteFormValidator $_newFormValidator $_updateFormValidator | ### Methods createAction deleteAction indexAction init updateAction _addIdFormElement _addNameFormElement _addParentIdElement _createNewFormValidator _createUpdateFormValidator
### Inherited Constants #### Class: Setuco_Controller_Action_AdminAbstract Setuco_Controller_Action_AdminAbstract::PAGE_LIMIT #### Class: Setuco_Controller_Action_Abstract Setuco_Controller_Action_Abstract::DOT_ADDITIONAL_STRING | ### Inherited Variables #### Class: Setuco_Controller_Action_AdminAbstract Setuco_Controller_Action_AdminAbstract::$_navigation Setuco_Controller_Action_AdminAbstract::$_pageLimit Setuco_Controller_Action_AdminAbstract::$_pageTitle | ### Inherited Methods #### Class: Setuco_Controller_Action_AdminAbstract Setuco_Controller_Action_AdminAbstract::init() adminモジュールコントローラの初期処理です。 Setuco_Controller_Action_AdminAbstract::postDispatch() アクションメソッドが呼ばれた後の処理です。 Setuco_Controller_Action_AdminAbstract::_addFormElementCommonOptions() フォームエレメントの共通設定をする requiredなどの設定をする 　第２引数で、設定しない項目を指定できる Setuco_Controller_Action_AdminAbstract::_chooseHeadTitle() リクエスト中のページのタイトルを取得します。 Setuco_Controller_Action_AdminAbstract::_getAccountInfos() ログインしているユーザーの情報を取得する Setuco_Controller_Action_AdminAbstract::_initHeader() ヘッダーに関する初期処理です。 Setuco_Controller_Action_AdminAbstract::_initNavigation() ナビゲーションの設定情報を初期化します。 #### 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 24] #### Tags:
author: | charlesvineyard suzuki-mar saniker10
[ Top ] ### Class Variables #### $_categoryService = null [line 31] 全アクションで使用するサービスクラス #### Tags:
access: | private
Type: | Admin_Model_Category
[ Top ] #### $_deleteFormValidator = null [line 49] 削除用のフォーム (エラーメッセージ）を入れるだけ #### Tags:
access: | private
Type: | Setuco_Form
[ Top ] #### $_newFormValidator = null [line 37] 新規登録用のバリデーションチェックフォーム #### Tags:
access: | private
Type: | Setuco_Form
[ Top ] #### $_updateFormValidator = null [line 43] 編集用のバリデーションチェックフォーム #### Tags:
access: | private
Type: | Setuco_Form
[ Top ] ### Class Methods ### method createAction [line 111]
`void createAction( )`
カテゴリーを新規作成するアクションです indexアクションに遷移します #### Tags:
author: | charlesvineyard suzuki-mar
throws: | POSTメソッドでアクセスしなかった場合　insert文の実行に失敗した場合
access: | public
[ Top ] ### method deleteAction [line 182]
`void deleteAction( )`
カテゴリーを削除するアクションです #### Tags:
author: | charlesvineyard suzuki-mar
throws: | idパラメーターがない場合　delete文の実行に失敗した場合
access: | public
[ Top ] ### method indexAction [line 83]
`void indexAction( )`
カテゴリーの新規作成するフォーム カテゴリーの一覧表示のアクションです 現在は、スタブからデータを取得している #### Tags:
author: | charlesvineyard suzuki-mar saniker10
access: | public
[ Top ] ### method init [line 58]
`void init( )`
コントローラーの共通設定をする 全アクションで使用するサービスクラスのインスタンスをオブジェクト変数にする #### Tags:
author: | suzuki-mar
access: | public
Overrides Setuco_Controller_Action_AdminAbstract::init() (adminモジュールコントローラの初期処理です。) [ Top ] ### method updateAction [line 147]
`void updateAction( )`
カテゴリーを更新処理するアクションです indexアクションに遷移します #### Tags:
author: | charlesvineyard suzuki_mar
throws: | POSTメソッドでアクセスしなかった場合、update文の実行に失敗した場合
access: | public
[ Top ] ### method _addIdFormElement [line 301]
`Zend_Form_Element _addIdFormElement( &$form)`
カテゴリーIDのフォームエレメントクラスのインスタンスをフォームクラスに追加する #### Tags:
return: | カテゴリーIDのフォームエレメントクラス
author: | suzuki-mar
access: | private
#### Parameters:
Setuco_Form　$form | &$form | フォームエレメントを追加するフォームクラス
[ Top ] ### method _addNameFormElement [line 255]
`void _addNameFormElement( &$form, string $validateType)`
カテゴリー名のフォームエレメントクラスのインスタンスをフォームクラスに設定する #### Tags:
author: | suzuki-mar
todo: | 多段になったらバリデートルールを修正する必要がある
access: | private
#### Parameters:
string | $validateType | バリデートルールのタイプ create updateのみ指定できる
Setuco_Form　$form | &$form | フォームエレメントを追加するフォームクラス
[ Top ] ### method _addParentIdElement [line 324]
`Zend_Form_Element _addParentIdElement( &$form)`
カテゴリーの親IDのフォームエレメントクラスのインスタンスをフォームクラスに追加する #### Tags:
return: | カテゴリーの親IDのフォームエレメントクラス
author: | suzuki-mar
access: | private
#### Parameters:
Setuco_Form　$form | &$form | フォームエレメントを追加するフォームクラス
[ Top ] ### method _createNewFormValidator [line 217]
`Setuco_Form _createNewFormValidator( )`
新規作成用のバリデートルールを作成する #### Tags:
return: | 新規作成用のフォーム
author: | suzuki-mar
access: | private
[ Top ] ### method _createUpdateFormValidator [line 234]
`Setuco_Form _createUpdateFormValidator( )`
編集用のバリデートオブジェクトを作成する #### Tags:
return: | 編集用のフォーム
author: | suzuki-mar
access: | private
[ Top ] Documentation generated on Mon, 07 Feb 2011 01:28:09 +0900 by phpDocumentor 1.4.3