開発(PHP):下層(直下)のサブリソースの情報を取得
下層(直下)のサブリソースの情報を取得するには、$modx->getDocumentChildren
メソッドを使用します。
構文
戻り値 = $modx->getDocumentChildren(
基準となる親リソースID,
公開リソース,
削除リソース,
取得するリソース情報,
その他条件,
並び替える基準,
順序,
件数
);
引数名 | 型 | 初期値 | 説明 | |
---|---|---|---|---|
第一引数 | 基準となる親リソースID | integer | 0 | サブリソースを取得する親リソースのID。 |
第二引数 | 公開状態 | integer | 1 | 取得するサブリソースが公開か非公開のどちらかの場合のみ取得する。 指定可能な値は次の通り。 0 ... 非公開1 ... 公開 |
第三引数 | 削除状態 | integer | 0 | 取得するサブリソースが削除済みかそうでないかの場合のみ取得する。 指定可能な値は次の通り。 0 ... 削除されていないリソース1 ... 削除済みのリソース |
第四引数 | 取得するリソース情報 | string | '*' | 取得するリソースの情報(変数)。 指定しない場合はすべてのリソース変数を取得する。 カンマ区切りで複数の情報を取得できる。 |
第五引数 | その他条件 | string | 引数の条件以外で絞り込みたい場合にSQL文で指定。 リソース情報をもとにする場合は先頭にsc.を付ける。 例: sc.pagetitle REGEXP \'[a-zA-Z]+$\' |
|
第六引数 | 並び替える基準 | string | 'menuindex' | 戻り値の配列の順序を変更することが可能で、基準となるリソース変数を指定する。 カンマ区切りで複数指定することが可能。 |
第七引数 | 順序 | string | 'ASC' | 第六引数'並び替える基準'で指定したリソース変数を基準に順序方向を指定する。 指定可能な値は次の通り。 ASC ... 昇順DESC ... 降順第六引数'並び替える基準'に合わせてカンマ区切りで複数指定することが可能。 |
第八引数 | 件数 | integer | 検出したリソースの件数を制限する。 指定しない場合は制限はなし。 |
戻り値
見つかったら2次元配列、見つからなかったまたは失敗したら空の配列を返します。
サンプルコード
$children = $modx->getDocumentChildren(3, 1, 0, 'pagetitle');
結果
Array
(
[0] => Array
(
[pagetitle] => Title 1
)
[1] => Array
(
[pagetitle] => Title 2
)
[2] => Array
(
[pagetitle] => Title 3
)
)