Docs For Class Admin_Model_Category

Admin

# Class: Admin_Model_Category Source Location: /application/modules/admin/models/Category.php
### Class Overview
    Common_Model_CategoryAbstract
       |
       --Admin_Model_Category
カテゴリー管理クラス #### Author(s): saniker10, suzuki-mar | ### Methods __construct countAllCategories deleteCategory findAllCategoryIdAndNameSet findCategories findNameById isExistsId registCategory updateCategory
### Inherited Variables #### Class: Common_Model_CategoryAbstract Common_Model_CategoryAbstract::$_categoryDao
### Class Details [line 26] カテゴリー管理クラス #### Tags:
author: | saniker10, suzuki-mar
[ Top ] ### Class Methods ### constructor __construct [line 34]
`Admin_Model_Category __construct( )`
初期設定をする #### Tags:
author: | suzuki_mar
access: | public
[ Top ] ### method countAllCategories [line 108]
`int countAllCategories( )`
検索条件で、リミットしなかった場合に該当結果が何件あったのかを取得する #### Tags:
return: | 何件該当したデータが存在したか
author: | suzuki-mar
access: | public
[ Top ] ### method deleteCategory [line 175]
`boolean deleteCategory( $id, int $deleteId)`
カテゴリーを削除する コントローラーから、削除するidを取得する #### Tags:
return: | 削除したか
author: | suzuki-mar
throws: | delete文の実行に失敗したら例外が発生する
access: | public
#### Parameters:
int | $deleteId | 削除するデータのID
| $id |
[ Top ] ### method findAllCategoryIdAndNameSet [line 92]
`array findAllCategoryIdAndNameSet( )`
カテゴリーIDと名前のセットを取得する。 #### Tags:
return: | キー:カテゴリーID、値:カテゴリー名の配列
author: | charlesvineyard
access: | public
[ Top ] ### method findCategories [line 48]
`array findCategories( String $order, int $pageNumber, int $limit)`
カテゴリーを取得する #### Tags:
return: | カテゴリー情報の一覧
author: | saniker10, suzuki-mar
access: | public
#### Parameters:
String | $order | カテゴリーを昇順か降順でソートするのか 文字列
int | $pageNumber | 取得するページ番号
int | $limit | 1ページあたり何件のデータを取得するのか
[ Top ] ### method findNameById [line 71]
`Sring findNameById( int $id)`
カテゴリー名をIDから取得する #### Tags:
return: | カテゴリー名 取得できなかったらfalse
author: | suzuki-mar
access: | public
#### Parameters:
int | $id | 取得するカテゴリーのID
[ Top ] ### method isExistsId [line 120]
`boolean isExistsId( numeric $id)`
指定したidのデータが存在するか #### Tags:
return: | 指定したidが存在するか
author: | suzuki-mar
access: | public
#### Parameters:
numeric | $id | 存在するかを調べるid
[ Top ] ### method registCategory [line 143]
`int registCategory( array $registData)`
カテゴリーを新規作成する コントローラーから、バリデートチェックした入力パラメーターをすべて取得する #### Tags:
return: | insertしたレコードのプライマリーキー
author: | suzuki-mar
todo: | バージョン2以降では、parent_idの設定をする
throws: | insert文の実行に失敗したら例外が発生する
access: | public
#### Parameters:
array | $registData | 新規登録するカテゴリーのデータ
[ Top ] ### method updateCategory [line 160]
`boolean updateCategory( int $id, $updateData, array $categoryInfo)`
カテゴリーを編集する コントローラーから、バリデートチェックした入力パラメーターをすべてと、編集するidを取得する #### Tags:
return: | 編集したか
author: | suzuki-mar
throws: | update文の実行に失敗したら例外が発生する
access: | public
#### Parameters:
int | $id | アップデートするデータのID
array | $categoryInfo | 入力したデータ: バリデートチェックした入力データ
| $updateData |
[ Top ] Documentation generated on Mon, 07 Feb 2011 01:28:09 +0900 by phpDocumentor 1.4.3