コンテンツタイプ【pay】：注文一覧
コンテンツタイプ【pay】：注文一覧
payモジュールにおける「注文一覧」を作成するコンテンツタイプです。
注文一覧コンテンツの作成
画面右上歯車マーク > コンテンツ > 新規作成
コンテンツID、カテゴリ名、コンテンツ名入力後、コンテンツタイプ：payを選択します。
| コンテンツ設定 | |
|---|---|
| コンテンツID |
コンテンツURLに使用されるIDとなります。https://システム設置先/contents.php?c=コンテンツID 設定後の変更は可能ですが、URLも変更されるのでご注意ください。 ※省略された場合、自動で採番されます。 |
| カテゴリ名 | コンテンツのカテゴリ管理をする場合は名称を設定します。 |
| コンテンツ名 | コンテンツの管理名称になります。 |
注文一覧、対象シートを選択します。
次に、基本的なページ情報の設定、閲覧権限や公開設定などを行います。
Webページのコーディングデータは、テンプレートHTMLのエリアで編集していきます。
コンテンツ情報 / コンテンツ設定
| コンテンツ情報 | |
|---|---|
| コンテンツタイプ | 「注文一覧」と表示していることを確認。 |
| コンテンツURL | コンテンツ（注文一覧ページ）の公開URL。 |
| 関連情報 | |
| 対象シート | コンテンツ作成時に設定した対象シート名を表示。 |
| コンテンツ設定 | |
| コンテンツID |
コンテンツURLで使用するID。 省略した場合は自動入力します。変更するとコンテンツURLも変更されます。 |
| カテゴリ名 | コンテンツのカテゴリ管理をする場合は名称を設定。 |
| コンテンツ名 | コンテンツ名は、わかりやすい名称を設定。 |
| 一覧表示件数 | 注文一覧ページにおける検索結果の一覧表示件数を指定。 |
| 公開範囲 |
注文一覧コンテンツはユーザーが公開範囲です。 複数のユーザーシートを作成している場合は閲覧可能とするシートを選択してください。 |
| 閲覧権限外の転送URL |
公開範囲と異なる権限でアクセスした場合の転送先URL。 ※一般権限で会員限定コンテンツにアクセスした場合などの転送先URLを指定。 |
| 対象デバイス | 作成したコンテンツの閲覧可能な端末を設定。 |
| 対象外デバイスの転送URL | 「対象デバイス」設定外の端末からアクセスした場合の転送先URLを設定。 |
| Basic認証 |
コンテンツ閲覧時にBasic認証をかけることができます。 IDとパスワードを設定。 |
| 公開設定 |
コンテンツ（注文一覧）の公開状態を設定。 ※新規作成時の初期値は「非公開」。 |
テンプレートHTML
「注文一覧」コンテンツでは、以下の編集エリアを用意しています。編集エリアでHTMLの編集や変数を挿入し、各画面を作成します。
基本HTML
コーディングしたHTMLをそのまま貼り付け、入力項目や表示項目の変数に置き換えるだけで注文一覧ページが作成できます。
▼検索フォームの作成
検索フォームを作成する場合、入力フォームの前後に「フォームスタート変数」と「フォームエンド変数」を配置します。
- フォームスタート変数：[form_start]、フォームエンド変数：[form_end]
- 検索ボタン：[form_search_button]
<div class="form-wrap">
[form_start]
<div class="mod-form">
<div class="box">
<div class="mod-table-form">
<table class="table-line">
<tbody>
<tr>
<th>フリーワード</th>
<td>[search_keyword]</td>
</tr>
<tr>
<th>決済方法</th>
<td>[search_pay_method]</td>
</tr>
</tbody>
</table>
</div>
</div>
============（省略）============
<div class="box-btn">
<div class="btn-block"> <input type="reset" value="リセット"> [form_search_button] </div>
</div>
</div>
[form_end]
</div>検索項目は以下変数を用意しています。
| 変数名 | 変数 | 説明 |
|---|---|---|
| 【検索】フリーワード （テキスト）【引数対応】 |
[search_keyword] | フリーワード検索 検索対象は、id、data_id、注文名 引数で属性を付与できます。 |
| 【検索】決済方法 （チェックボックス） |
[search_pay_method] | 決済方法のチェックボックス検索 選択肢の対象は以下になります。 ・シート編集 > 決済方法で選択肢として定義している ・決済方法設定でステータスが有効になっているもの |
| 【検索】注文種別 （チェックボックス） |
[search_pay_type] | 注文種別のチェックボックス検索 都度決済 / 継続決済 |
| 【検索】商品合計金額 （範囲） |
[search_pay_total_amount] | 商品合計金額の範囲検索 ※継続決済の「初回」は対象外です。 |
▼一覧変数の設置
決済一覧を表示させるエリアは、変数：[list] を配置します。出力内容は、次に編集する「一覧挿入HTML」記述します。
一覧挿入HTML
基本HTMLに配置した変数：[list] で繰り返し表示させる内容を記述します。
注文情報に関する変数を用意しています。それぞれ以下の値を返します。
| 変数名 | 変数 | 説明 |
|---|---|---|
| システムID | [pay_id] | システムID |
| ID | [pay_data_id] | データID |
| 注文名 | [pay_name] | 注文名 |
| 注文対象ID | [pay_target_id] | 注文対象のシステムID |
| 注文対象（表示項目） | [pay_target_id_name] | 注文対象の表示項目に指定された値 ※対象シートの表示項目設定に依存します。 |
| 決済方法 | [pay_pay_method] | 決済方法 |
| 注文種別 | [pay_pay_type] | 注文種別 |
| 商品合計金額 | [pay_pay_total_amount] | 商品合計金額 カンマ区切りで出力 |
| 商品合計金額（初回） | [pay_pay_first_amount] | 継続決済時の商品合計金額（初回） カンマ区切りで出力 |
| 注文日時 | [pay_regist] | 注文日時を日付（Y/m/d H:i:s）で出力 |
| 注文日時（unixtime） | [pay_unixtime_regist] | 注文日時をunixtimeで出力 |
| 継続状態 | [pay_pay_fixed_state] | 継続決済での継続状態 |
| 継続条件 | [pay_pay_fixed_option] | 継続条件 |
| 継続決済予定日 | [pay_pay_fixed_next] | 次回の決済が行われる日付（Y/m/d）を出力 |
| 継続決済予定日（unixtime） | [pay_unixtime_pay_fixed_next] | 次回の決済が行われる日付をunixtimeで出力 |
| 小計（税率別）【引数対応】 | [pay_price] | 指定の消費税率別の小計 引数は消費税率を指定。未指定時は10％ 記述例：消費税8％の場合 [pay_price:8] |
| 消費税（税率別）【引数対応】 | [pay_tax_price] | 指定の消費税率別の消費税 引数は消費税率を指定。未指定時は10％ 記述例：消費税8％の場合 [pay_tax_price:8] |
| 小計 | [pay_total_price] | 小計 |
| 消費税（額） | [pay_total_tax_price] | 消費税 |
| 【対象情報】任意項目変数 | [モジュール名_origin_項目名] | 対象シートの任意項目情報を出力 |
【結果なしHTML】
注文情報の検索結果が0件だった場合のページを用意することができます。
【基本HTML】に記述したソースコードを流用して一覧表示エリアに「お探しの注文情報はありません。」などのテキストを配置します。
コンテンツのページ遷移について
注文一覧ページから他のコンテンツに当該のレコード情報をもって遷移する場合は、 遷移先のコンテンツIDに遷移元のシステムID（対象のレコード情報）を渡します。
システムIDはHTML編集画面の変数一覧から選択が可能です。
※コンテンツタイプごとのシステムID名は以下一覧をご参照ください。
| コンテンツタイプ | HTML入力画面 | システムIDの変数 | システムIDの和名称 |
|---|---|---|---|
| 注文編集 | 入力 | pay_info_id | システムID【表示用】 |
| 確認 | pay_id | システムID | |
| 注文一覧 | 一覧 | pay_id | システムID |
| 決済一覧 | 一覧 | pay_history_pay | 【注文情報】システムID |
| 注文詳細 | 基本 | pay_id pay_target_id |
システムID 注文対象ID |
| 結果なし | pay_id pay_target_id |
システムID 注文対象ID |
|
| entry / user | 完了 | pay_id | システムID |
遷移先コンテンツIDに遷移元システムIDを渡し、aタグに指定することで、該当のレコード情報を保持した状態で遷移します。
- 例① 遷移元：注文一覧ページより、注文詳細（コンテンツID：pay_entry_detail）に遷移
- ./contents.php?c=pay_entry_detail&pay=[pay_id]
- 例② 遷移元：注文一覧ページより、注文編集（コンテンツID：pay_edit）に遷移
- ./contents.php?c=pay_edit&id=[pay_id]
| 遷移元 | ||||
|---|---|---|---|---|
| 注文一覧 | 注文詳細 | 決済一覧 | ||
| 遷移先 | 注文一覧 | － | － | － |
| 注文詳細 | pay=[pay_id] | － | pay=[pay_history_pay] | |
| 決済一覧 | pay=[pay_id] | pay=[pay_id] | － | |
| 注文編集 | id=[pay_id] | id=[pay_id] | id=[pay_history_pay] | |
