この関数について
引数に指定された条件によりコンテンツやセットのページャを取得する関数です。
主にコンテンツ及びセットの一覧を表示するときに利用します。
詳細仕様
function get_contents_pager($condition, int $page = 1, int $size = 12)引数
| 第1引数 | $condition | 検索条件を表すオブジェクト。 |
|
第2引数 |
$page | 表示するページ数を表す整数値 |
| 第3引数 | $size | 1ページに表示する（1度に取得する）コンテンツの件数を表す整数値 |
第1引数$conditionについて
$conditionには下記のプロパティを設定可能です。具体的な設定方法は「使用例」をご確認ください
| プロパティ名 | 意味 | 型 | 説明 | |||
| search | 検索条件 | オブジェクト | ||||
| display_name | タイトル | 文字列 | 部分一致での検索となります | |||
| keywords | キーワード | 配列 | 検索対象文字列の配列 「タイトル」「説明文」「タグ」が検索対象となります |
|||
| type | 種別 | 文字列 | set: セット single: コンテンツ ※未設定はセットとコンテンツ両方を表示 |
|||
| limit_types | 公開範囲 | 配列 | 0: 誰にでも公開 1: 会員のみに公開 2: 購入者のみに公開 3: 見放題購入者のみに公開 4: セットの公開範囲に依存 5: 視聴コード入力者に公開 |
|||
| category_ids | 配列 | カテゴリIDの配列 | ||||
| tags | 文字列 | 検索したい「タグ」 ※バージョン4.4.8現在複数のタグでの検索はサポートしておりません、代替としてkeywordsの使用をご検討ください |
||||
| delivery_start_at | 配信開始日時 | 配列 | start と end のどちらか（または両方）のキーを持つ配列 | |||
| start | 日付 |
"Y-m-d H:i:s" 形式 |
||||
| end | 日付 |
"Y-m-d H:i:s" 形式 |
||||
| sale_start_at | 販売開始日時 | 配列 | start と end のどちらか（または両方）のキーを持つ配列 | |||
| start | 日付 |
"Y-m-d H:i:s" 形式 |
||||
| end | 日付 |
"Y-m-d H:i:s" 形式 |
||||
| sort | ソート項目 | 文字列 | i: ID di_s: 表示開始日 di_e: 表示終了日 de_s: 配信開始日 de_e: 配信終了日 sa_s: 販売開始日 sa_e: 販売終了日 fc: お気に入りされた数 pc: 再生された数 p: 値段 |
|||
| order | 並び順 | 文字列 | d: 降順 a: 昇順 |
|||
戻り値
検索条件に一致するコンテンツの一覧を表すページャー
⇒ ページャについて
使用例
コンテンツとセットを1ページにつき30件取得する
{% set paginator = get_contents_pager({}, input_get('page', 1), 30) %}
セットだけを1ページにつき15件取得する
{% set paginator = get_contents_pager({search: {type: 'set'}}, input_get('page',
1), 15) %}コンテンツだけを1ページにつき15件取得する
{% set paginator = get_contents_pager({search: {type: 'single'}}, input_get('page',
1), 15) %}ID:1のカテゴリに属するコンテンツを、再生数順の大きい順に10件取得する
{% set paginator = get_contents_pager({search: {type: 'single', category_ids:[1]}, sort: 'pc', order: 'd'}, input_get('page',
1), 10) %}対応バージョン
4.0.0 以降