PHPでURLパラメータを取得したり、PHPの実行結果をページやブロックに表示したい。
ページに設定したPHPを使って、ページのURLパラメータを取得したり、PHPの実行結果をページやブロックに表示する機能を提供しています。
当該機能を使用するには、独自クラス「$SPIRAL」にアクセスし、独自関数を使用します。
使い方
//URLパラメータを取得
$SPIRAL->getParam("seminar_id");
提供している関数は下記の通りです。
関数の仕様や使い方は、下記関数名のリンクをクリックしてください。
目次
ページのURLパラメータやPOSTデータを取得する関数
ページのURLに付与されているクエリパラメータをPHPで取得する場合、こちらの関数を使ってください。
例えば、ページURLに、製品ごとに異なるURLパラメータを付与し、ページにPHPを設定すると、アクセスされた製品ごとにページの表示内容を変えることができます。
製品AのページURL：https://example.spiral-site.com/page?pid=1 → 「製品Aの概要」
製品BのページURL：https://example.spiral-site.com/page?pid=2 → 「製品Bの概要」
getParam()…ページのURLパラメータやPOSTで送信されてきた値を一つ取得します。
getParams()…ページのURLパラメータやPOSTで送信されてきた値を複数まとめて（配列）取得します。
getQueryParam()…ページのURLパラメータを一つ取得します。
getQueryParams()…ページのURLパラメータを複数まとめて（配列）取得します。
getPostParam()…POSTで送信されてきた値を一つ取得します。
getPostParams()…POSTで送信されてきた値を複数まとめて（配列）取得します。
PHPの実行結果をページやブロックに表示する関数
ページに設定したPHPの実行結果を、ページやブロック上に表示する場合、こちらの関数を使ってください。
この関数はPHPの実行結果をThymeleaf側に渡します。
Thymeleaf側に渡した値をページやブロック上にそのまま表示したり、Thymeleafで条件によって表示を変えることができます。
例えば、在庫管理アプリで、在庫DBの在庫数を調べ（PHPとAPIを使用）、在庫が少ない場合だけ、ページ上に「発注が必要」と表示することができます。
また、PHPのechoなど、実行結果を画面上に表示する関数の代わりに、こちらの関数を設定して画面上に表示してください。
setTHValue()…Thymeleafへ値を一つ渡します。
setTHValues()…Thymeleafへ値を複数まとめて渡します。
PHP環境変数に登録した値を取り出す関数
サイト管理の「PHP環境変数」によく使う値を登録しておき、登録した値をPHP内で取り出す場合、こちらの関数を使ってください。
認証エリアページにて、認証レコード値を取得する関数
認証エリアにログインした後のページにて、例えば、ログインしたエンドユーザの属性情報などの認証レコード値をPHPで取得する場合、こちらの関数を使ってください。
フォームブロックのステップを取得する関数
ページに設定したフォームブロックのどのステップが表示されているかを取得できます。
入力ステップで実行したい処理、完了ステップで実行したい処理など、ステップで処理を分けたい場合、こちらの関数を使ってください。
フォームの完了ステップで値を取得する関数
登録フォームで登録した値または更新フォームで更新した値を、完了ステップで取得する場合、こちらの関数を使ってください。