リファレンス1
1. XoopsSimpleObject
2. XoopsObjectsGenericHandler
3. Criteria
4. CriteriaCompo
XoopsSimpleObjectクラス
テーブル操作をするための基底クラス。主に値の入出力を実施する。
ファイル場所:/module/legacy/kernel/object.php
XoopsSimpleObject | ||||||||||||||||
主なメンバ変数 | ||||||||||||||||
$mVars | テーブルのフィールド名がキーの配列。initVar()で指定された値が配列にセットされる。 | |||||||||||||||
$mIsNew | テーブルハンドラのinsert関数でtrueの場合はINSERTがfalseの場合はUPDATEが実行されます。 | |||||||||||||||
主なメンバ関数 | ||||||||||||||||
initVar($key, $dataType, $value=null, $required=false, $size=null) |
|
|||||||||||||||
assaignVar($key, $value) |
|
|||||||||||||||
setNew() |
|
|||||||||||||||
unsetNew() |
|
|||||||||||||||
isNew() |
|
XoopsObjectGenericHandlerクラス
テーブル操作をするための基底クラス。主にデータベースとのやり取りを実施する。
ファイル場所:/module/legacy/kernel/handler.php
XoopsObjectGenericHandler | ||||||||||||||
主なメンバ変数 | ||||||||||||||
$db | データベースオブジェクトがセットされる。 | |||||||||||||
$mTable | テーブル名がセットされる。 | |||||||||||||
$mPrimary | テーブルのプライマリーキーがセットされる。 | |||||||||||||
$mClass | テーブルオブジェクトクラス名がセットされる。 | |||||||||||||
主なメンバ関数 | ||||||||||||||
XoopsObjectGenericHandler(&$db) |
|
|||||||||||||
create($isNew=true) |
|
|||||||||||||
get($id) |
|
|||||||||||||
getObjects($criteria=null, $limit=null, $start=null, $id_as_key=false) |
|
|||||||||||||
getCount($criteria=null) |
|
|||||||||||||
insert(&$obj, $force=false) |
|
|||||||||||||
delete(&$obj, $force=false) |
|
|||||||||||||
deleteAll($criteria, $force=false) |
|
Criteriaクラス
データベースの問い合わせを簡易にするためのクラス。主にクライテリア(問い合わせ内容)を指定します。
ファイル場所:/class/criteria.php
XoopsSimpleObject | ||||||||||||||||
主なメンバ変数 | ||||||||||||||||
$order | 配列。setSort、addSort実行時の指定ソート順が追加されていく。 | |||||||||||||||
$sort | 配列。setSort、addSort実行時の指定されたソート実施のためのフィールド名が追加されていく。 | |||||||||||||||
$limit | setLimitでセットされる取得するレコード数 | |||||||||||||||
$start | setStartでセットされる取得するレコードの開始行 | |||||||||||||||
主なメンバ関数 | ||||||||||||||||
Criteria($column, $value='', $operator='=', $prefix='', $function='') |
|
|||||||||||||||
setSort($sort, $order=null) |
|
|||||||||||||||
addSort($sort, $order=null) |
|
|||||||||||||||
setLimit($limit=0) |
|
|||||||||||||||
setStart($start=0) |
|
CriteriaCompoクラス
データベースの問い合わせを簡易にするためのクラス。各クライテリア(問い合わせ内容)をまとめて問い合わせ条件を作成することもできます。
ファイル場所:/class/criteria.php
XoopsSimpleObject | ||||||||||
主なメンバ変数 | ||||||||||
$criteriaElements | 配列。add実行時の指定クライテリアオブジェクトが追加されていく。 | |||||||||
$conditions | 配列。add実行時の指定論理演算子が追加されていく。 | |||||||||
$order | 配列。setSort、addSort実行時の指定ソート順が追加されていく。 | |||||||||
$sort | 配列。setSort、addSort実行時の指定されたソート実施のためのフィールド名が追加されていく。 | |||||||||
$limit | setLimitでセットされる取得するレコード数 | |||||||||
$start | setStartでセットされる取得するレコードの開始行 | |||||||||
主なメンバ関数 | ||||||||||
CriteriaCompo($ele=null, $condition='AND') |
|
|||||||||
add(&$criteriaElement, $condition='AND') |
|
|||||||||
setSort($sort, $order=null) |
|
|||||||||
addSort($sort, $order=null) |
|
|||||||||
setLimit($limit=0) |
|
|||||||||
setStart($start=0) |
|