Docs For Class Setuco_Db_Table_Abstract

Setuco

# Class: Setuco_Db_Table_Abstract Source Location: /library/Setuco/Db/Table/Abstract.php
### Class Overview
    Zend_Db_Table_Abstract
       |
       --Setuco_Db_Table_Abstract
#### Author(s): charlesvineyard | ### Constants BACKSLASH_REPLACER | ### Methods countAll deleteByPrimary escapeLikeString getBsReplacedExpression loadByPrimary updateByPrimary
### Child classes: Common_Model_DbTable_Account Common_Model_DbTable_Ambition Common_Model_DbTable_Category Common_Model_DbTable_Goal Common_Model_DbTable_Media Common_Model_DbTable_Page Common_Model_DbTable_PageTag Common_Model_DbTable_Site Common_Model_DbTable_Tag
### Class Details [line 23] #### Tags:
author: | charlesvineyard
abstract: |
[ Top ] ### Class Methods ### method countAll [line 38]
`int countAll( )`
全部で何件あるのか取得する #### Tags:
return: | 全てのデータ件数
author: | suzuki-mar charlesvineyard
access: | public
Overridden in child classes as: Common_Model_DbTable_Category::countAll() 全ての有効なカテゴリーの件数を数えます。 [ Top ] ### method deleteByPrimary [line 92]
`boolean deleteByPrimary( mixed $key)`
指定されたIDのレコードを削除します。 このメソッドは複合キーに対応するため可変長引数です。 主キーが2つからなる複合キーの場合は、次のように1つ1つを引数に指定して呼び出してください。 それぞれが _primary に指定したカラムと順序に対応します。 deleteByPrimary('キー１の値', 'キー2の値'); #### Tags:
return: | 削除できたら true。該当レコードが存在しなければ false。
author: | akitsukada charlesvineyard
access: | public
#### Parameters:
mixed | $key | プライマリキーの値(複数の場合あり)
[ Top ] ### method escapeLikeString [line 176]
`string escapeLikeString( string $str)`
WHERE句のLIKE演算子や正規表現に与える文字列を\（バックスラッシュ）でエスケープします。 エスケープされた文字が検索できるようになります。 バックスラッシュ自体を検索するときは、getBsReplacedExpressionとセットで使う必要があります。 #### Tags:
return: | エスケープ済みの検索対象文字列
author: | akitsukada
access: | public
#### Parameters:
string | $str | LIKE検索を行う検索対象文字列
[ Top ] ### method getBsReplacedExpression [line 193]
`string getBsReplacedExpression( string $columnName)`
$columnNameにSQL文のカラム名、リテラルを受け取り、MySQL,PostgreSQLのreplace関数を 適用した表現を返します。replace関数は'\'をBACKSLASH_REPLACERに置換します。 例："col" → "replace(col, '\\\\', '__BACKSLASH__')" LIKE検索時には、escapeLikeStringとセットで使う必要があります。 #### Tags:
return: | 受け取ったカラム名にreplace関数を適用した表現
author: | akitsukada
access: | public
#### Parameters:
string | $columnName |
[ Top ] ### method loadByPrimary [line 62]
`array|null loadByPrimary( mixed $key)`
IDからひとつの行を取得し、配列で返します。 行が見つからなければ null を返します。 このメソッドは複合キーに対応するため可変長引数です。 主キーが2つからなる複合キーの場合は、次のように1つ1つを引数に指定して呼び出してください。 それぞれが _primary に指定したカラムと順序に対応します。 loadByPrimary('キー１の値', 'キー2の値'); このメソッドは親クラスのfindメソッドに委譲しています。 呼び出しに関する制約はそちらのコメントも参照してください。 #### Tags:
return: | 取得した行の配列。なければ null。
author: | charlesvineyard
see: | Zend_Db_Table_Abstract::find()
access: | public
#### Parameters:
mixed | $key | プライマリキーの値(複数の場合あり)
[ Top ] ### method updateByPrimary [line 136]
`boolean updateByPrimary( array $updateData, mixed $key)`
指定されたIDのレコードを更新する。 このメソッドは複合キーに対応するため可変長引数です。 主キーが2つからなる複合キーの場合は、次のように1つ1つを引数に指定して呼び出してください。 それぞれが _primary に指定したカラムと順序に対応します。 deleteByPrimary('キー１の値', 'キー2の値'); #### Tags:
return: | 更新できたら true。該当レコードが存在しなければ false。
author: | charlesvineyard
access: | public
#### Parameters:
array | $updateData | キー:カラム名、値:更新する値の配列。
mixed | $key | プライマリキーの値(複数の場合あり)
[ Top ] ### Class Constants #### BACKSLASH_REPLACER = '__BS__' [line 30] SQL文中のバックスラッシュ(\)を置換する文字列 [ Top ] Documentation generated on Mon, 07 Feb 2011 01:28:03 +0900 by phpDocumentor 1.4.3