ver.2サポートサイト

HOME機能アプリ管理アプリアプリのPHPモジュール

アプリのPHPモジュール

機能概要

よく使うPHPプログラムを部品化して、モジュールとして保存する機能です。

保存したPHPモジュールはアプリのDBトリガやアクションから呼び出して使うことができます。

例えば、SPIRAL ver.2や外部サービスのAPIへ接続する共通のプログラムを保存し、複数のトリガやアクションから呼び出して使います。

サイト管理でPHPモジュールを使用する方法は、サイトのPHPモジュールをご覧ください。

機能仕様

構成

・フォルダとモジュールで構成されます。

・1アプリにつき、フォルダとモジュールを合わせて、200個まで作成できます。

フォルダ

・同じ階層内に同じフォルダ名は付けられません。

・最大5階層まで作成できます(1階層目はデフォルトで作成されています)

・1つの階層内に、フォルダとモジュールを合わせて、100個まで作成できます。

・フォルダを別の階層に移動することはできません。一旦削除してから、作成し直してください。

モジュール

・同じフォルダ内に同じモジュール名は付けられません。

・モジュールに記述できるプログラムの文字数は、300,000文字です。

注意事項

フォルダやモジュールを削除、名称変更する場合

アプリのPHPまたはPHPモジュールから当該モジュールが参照されている場合、呼び出し元のアプリまたはPHPモジュール内のファイルのパスは自動的に更新されません。
フォルダやモジュールが見つからず、エラーになりますので、呼び出し元のアプリまたはPHPモジュール内のファイルのパスも合わせて修正する必要があります。

 

エラーが発生した場合

モジュール内のPHP実行中にエラーが発生した場合、PHPモジュール上でエラーを検知するのではなく、呼び出し元のトリガやアクション上でエラーを検知し、メール通知やログに記録します。
詳しくは呼び出し元のトリガやアクションのPHPエラー通知メール設定やアクション履歴をご覧ください。

PHPエラー通知メール設定

スケジュールトリガ>PHP実行アクション>アクション履歴

DBトリガ>PHP実行アクション>アクション履歴

 

呼び出せるPHPモジュール

アプリ管理のPHPモジュールはモジュールを保存したアプリ内で利用できます。アプリをまたいでの利用はできません。
サイト管理で保存したPHPモジュールは利用できません。

UI:モジュール/フォルダの作成

モジュール/フォルダを新規作成する場合、PHPモジュールの「+」ボタンをクリックして、「モジュール作成」または「フォルダ作成」を選択します。

 

フォルダの新規作成

フォルダ名を入力し、「追加」を選択します。

 

モジュールの新規作成

モジュール名とPHPソースコードを入力し、「追加」を選択します。

設定内容は後から編集できます。

UI:フォルダ名の変更や削除

操作したいフォルダの「︙」をクリックし、表示されるメニューから実行したい操作を選択します。

UI:モジュールの編集や削除

モジュール名をクリックすることでモジュールの詳細画面を開き、「編集」を選択することでモジュールの編集ができます。

または操作したいモジュールの「︙」をクリックして、表示されるメニューから編集や削除ができます。

アプリからPHPモジュールを利用する

アプリ管理のPHPモジュールはアプリの以下の機能で利用できます。

・DB > DBトリガ > 非同期アクション > PHP実行

・スケジュールトリガ > アクション > PHP実行

・アクション > PHP実行

アプリの各機能からPHPモジュールを呼び出す方法は以下の2通りになります。

 

PHPモジュール挿入から挿入する

(1)PHPモジュールを呼び出したい場所にカーソルを当てて、「PHPモジュール挿入」ボタンをクリックします。

 

(2)モジュールを選択して、追加ボタンを選択します。

 

(3)モジュールのパスがソースコードに入ります。

 

直接モジュールのパスを記述する

require_once()を利用し、直接モジュールのパスを記述します。