サイトのPHPモジュール
目次
機能概要
よく使うPHPプログラムを部品化して、モジュールとして保存する機能です。
保存したPHPモジュールはページのPHPにて、呼び出して使うことができます。
例えば、SPIRAL ver.2や外部サービスのAPIへ接続するプログラムを保存し、複数のページから呼び出して使います。
アプリ管理でPHPモジュールを使用する方法は、アプリのPHPモジュールをご覧ください。
機能仕様
構成
・フォルダとモジュールで構成されます。
・テスト環境と本番環境とで、それぞれモジュールを保存する場所があります。
テスト環境でテストをした後、本番環境へリリースします。
・1サイトにつき、フォルダとモジュールを合わせて、200個まで作成できます。
フォルダ
・同じ階層内に同じフォルダ名は付けられません。
・最大5階層まで作成できます（1階層目はデフォルトで作成されています）
・1つの階層内に、フォルダとモジュールを合わせて、100個まで作成できます。
・フォルダを別の階層に移動することはできません。一旦削除してから、作成し直してください。
モジュール
・同じフォルダ内に同じモジュール名は付けられません。
・モジュールに記述できるプログラムの文字数は、300,000文字です。
・サイト管理のPHP環境変数に保存した値を呼び出すことができます。
PHP環境変数の呼び出し方は、こちらをご覧ください。
注意事項
本番リリース時
PHPモジュールを本番環境へリリースする場合、上位フォルダのリリース状態によって、モジュールがリリースできない場合があるので、ご注意ください。
・上位フォルダがまだリリースされていない場合、当該フォルダ内のモジュールをリリースできません。
・上位フォルダを削除でリリースする場合、当該フォルダ内のモジュールはリリース対象に表示されません。
フォルダやモジュールを削除、名称変更する場合
ページのPHPまたはPHPモジュールから当該モジュールが参照されている場合、呼び出し元のページまたはPHPモジュール内のファイルのパスは自動的に更新されません。
フォルダやモジュールが見つからず、エラーになりますので、呼び出し元のページまたはPHPモジュール内のファイルのパスも合わせて修正する必要があります。
エラーが発生した場合
モジュール内のPHP実行中にエラーが発生した場合、PHPモジュール上でエラーを検知するのではなく、モジュールを呼び出したページ上でエラーを検知し、ページ上にエラーを表示したり、メール通知やログに記録します。
ページ上にPHPエラーを表示する方法は、こちらをご覧ください。
PHPエラー通知メールやログを確認する方法は、こちらをご覧ください。
呼び出せるPHPモジュール
サイト管理のPHPモジュールはモジュールを保存したサイト内のページで利用できます。サイトをまたいでの利用はできません。
アプリ管理で保存したPHPモジュールは利用できません。
UI：モジュールやフォルダの作成
モジュールやフォルダを新規作成する場合、PHPモジュールの「＋」ボタンをクリックして、「モジュール作成」または「フォルダ作成」を選択します。
1.フォルダの新規作成
2.モジュールの新規作成
モジュール名とPHPソースコードを入力し、追加ボタンをクリックします。
ソースコードは後から編集できます。
UI：フォルダ名の変更や削除
フォルダ名の「︙」をクリックします。
UI：モジュールの編集や削除
モジュールを編集する場合、モジュール一覧にて、モジュール名をクリックするか、「︙」をクリックして、「詳細」を選択します。
モジュールを削除する場合、モジュール名の「︙」をクリックして、「削除」を選択します。
ページのPHPからの呼び出し方
ページのPHPからモジュールを呼び出す方法は2通りあります。
1.PHPモジュール挿入ボタンをクリックする。
（1）ページのPHPタブにて、PHPモジュールを呼び出したい場所にカーソルを当てて、「PHPモジュール挿入」ボタンをクリックします。
（2）モジュールを選択して、追加ボタンをクリックします。
（3）モジュールのパスがソースコードに入ります。
2.手動でモジュールのパスを記述する。
include_once() かrequire_once()を使い、モジュールのパスを記述します。
