「関数リファレンス/BcBaser getPageList」の版間の差分
提供: baserCMS公式ガイド
行1: | 行1: | ||
## 説明 | ## 説明 | ||
− | + | 固定ページ機能で作成したページの一覧データを取得する。 | |
## 使い方 | ## 使い方 | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
− | $this->BcBaser->getPageList( [$categoryId] ); | + | $this->BcBaser->getPageList( [$categoryId], [$option]); |
</syntaxhighlight> | </syntaxhighlight> | ||
## パラメータ | ## パラメータ | ||
− | $categoryId | + | (string)$categoryId |
− | : | + | : 固定ページカテゴリID(初期値 : null) |
− | : | + | : ※ 指定しない場合は全ページを取得 |
− | : ※ | + | |
- 初期値:null | - 初期値:null | ||
+ | (array)$option | ||
+ | : `conditions` : 検索条件(初期値 : array('Page.status' => 1)) | ||
+ | : `fields` : 取得フィールド(初期値 : array('title', 'url')) | ||
+ | : `order` : 並び順(初期値 : array('Page.sort')) | ||
+ | - 初期値:array() | ||
## 戻り値 | ## 戻り値 | ||
− | + | (mixed) | |
+ | : ページ一覧、または、false | ||
## 用例 | ## 用例 |
2014年11月18日 (火) 15:35時点における版
目次
説明
固定ページ機能で作成したページの一覧データを取得する。
使い方
$this->BcBaser->getPageList( [$categoryId], [$option]);
パラメータ
- (string)$categoryId
- 固定ページカテゴリID(初期値 : null)
- ※ 指定しない場合は全ページを取得 - 初期値:null
- (array)$option
conditions
: 検索条件(初期値 : array('Page.status' => 1))fields
: 取得フィールド(初期値 : array('title', 'url'))order
: 並び順(初期値 : array('Page.sort')) - 初期値:array()
戻り値
- (mixed)
- ページ一覧、または、false