カスタムモジュール
最終更新日:2024年02月29日
概要
スパイラルでは、PHPプログラムにおいて共通で利用する処理をモジュールという単位でPHPファイルとして管理することが出来ます。
複数のWebページで利用する共通のモジュールを置くことができるため、共通モジュールを変更することにより、
一括でWebページの変更を行うといったことも可能で、コーディングの生産性と保守性を高めることができます。
1. カスタムモジュールの新規作成
「開発」＞「カスタムモジュール」をクリックします。
作成したカスタムモジュールの一覧が表示されます。
「新規作成」をクリックします。
ソースフォルダと名前を入力し「作成」ボタンをクリックします。
- ソースフォルダ
カスタムモジュールを設置するフォルダを指定します。
スラッシュ区切りで階層も指定できます。フォルダ名には日本語は使えません。
半角英数とハイフン、アンダースコアのみ使用出来ます。
- 名前
カスタムモジュールの名前です。
requireで指定するときは、フォルダ名とファイル名をスラッシュでつなげ、.phpを最後につけます。
編集したいファイルを選択します。
カスタムモジュールの基本情報を編集し「保存」ボタンをクリックします。
- 名前
カスタムモジュールの名前を設定します。他のカスタムモジュールと重複する名前は設定できません。
※ 最大128byte
- 実行時のファイルパス
カスタムモジュールのファイルパスです。requireするときに指定するパスになります。
- コメント
カスタムモジュールに関するコメントを設定します。
※ 最大512byte
- PHPスクリプト
実行するPHPスクリプトを記入します。
※ 最大256KB
カスタムモジュールで１つのフォルダに複数のモジュールをアップする方法
既に、ソースフォルタ:test、名前：moduleのカスタムモジュールを作成していた場合
（１）開発＞カスタムモジュールにて、新規作成ボタンをクリックし、ソースフォルダで「test」を入力
（２）名前に「module2」と入力
（３）作成ボタンをクリック
カスタムモジュール一覧にて、「test」が表示されておりますので、クリックすると「module」と「module2」が表示されます。
2. 一括アップロード
本機能はスパイラルver1.12.8でリリースされる内容です。
複数のカスタムモジュールのファイルをアップロードする際は、「一括アップロード」をクリックします。
アップロードしたいカスタムモジュールファイルをZIP形式にして、ファイルを選択し、アップロードします。
注意事項
- カスタムモジュール一覧に同階層、同ファイル名がある場合、アップロードする内容に上書きされます。
意図しないファイル等が含まれていないことを確認した上でアップロードしてください。
- 対応しているファイル形式は「.zip」です。
- アーカイブファイル、アーカイブ内ファイル、フォルダ名は、半角英数で作成してください。
- PHPスクリプトファイルはUTF-8エンコードにのみ対応しています。
3. 一括ダウンロード
本機能はスパイラルver1.12.8でリリースされる内容です。
作成済みのカスタムモジュールファイルをZIP形式でダウンロードできます。
4. アップローダーツールのダウンロード
アップロードツールをダウンロードして利用することでローカルから直接phpのファイルをアップロードすることができます。
カスタムモジュール一覧画面の「説明を表示」ボタンをクリックします。
「7.アップロードツール」のリンクからツールをダウンロードします。
5. スパイラルAPIを使用したモジュールのアップロード
APIのcustom_moduleの仕様およびサンプルプログラムは下記をご覧ください。