開発(PHP):特定の複数のリソースの情報を取得
特定の複数のリソースの情報を取得するには、$modx->getDocuments
メソッドを使用します。
テンプレート変数は含まれませんのでご注意ください。
構文
戻り値 = $modx->getDocuments(
リソースID,
公開対象,
削除対象,
取得するリソース情報,
条件,
並び替える基準,
順序,
件数
);
引数名 | 型 | 初期値 | 説明 | |
---|---|---|---|---|
第一引数 必須 |
リソースID | array | array() | 取得するリソースのリソースID。array(3, 11) のように指定。 |
第二引数 | 公開状態 | integer | 1 | 取得するリソースが公開か非公開のどちらかの場合のみ取得する。 指定可能な値は次の通り。 0 ... 非公開1 ... 公開 |
第三引数 | 削除状態 | integer | 0 | 取得するリソースが削除済みかそうでないかの場合のみ取得する。 指定可能な値は次の通り。 0 ... 削除されていないリソース1 ... 削除済みのリソース |
第四引数 | 取得するリソース情報 | string | * | 取得するリソースの情報(変数)。 指定しない場合はすべてのリソース変数を取得する。 カンマ区切りで複数の情報を取得できる。 |
第五引数 | 条件 | string | リソース変数を対象にさらに条件を絞り込むことが可能。 例えばコンテナのみを取得したい場合は 'isfolder=1' のように指定する。カンマ区切りで複数条件を指定することが可能。 |
|
第六引数 | 並び替える基準 | string | 'menuindex' | 戻り値の配列の順序を変更することが可能で、基準となるリソース変数を指定する。 カンマ区切りで複数指定することが可能。 |
第七引数 | 順序 | string | 'ASC' | 第六引数'並び替える基準'で指定したリソース変数を基準に順序方向を指定する。 指定可能な値は次の通り。 ASC ... 昇順DESC ... 降順第六引数'並び替える基準'に合わせてカンマ区切りで複数指定することが可能。 |
第八引数 | 件数 | integer | 検出したリソースの件数を制限する。 指定しない場合は制限はなし。 |
戻り値
見つかった場合は2次元配列で返し、見つからなかったら0件の配列を返します。
サンプルコード
$infos = $modx->getDocuments(array(3,7,13), 1, 0, 'id,pagetitle');
結果
Array
(
[0] => Array
(
[id] => 3
[pagetitle] => foo
)
[1] => Array
(
[id] => 7
[pagetitle] => bar
)
[2] => Array
(
[id] => 13
[pagetitle] => baz
)
)