開発室ノート | プラグインリソース

Serene Bachではプラグイン毎に独立してリソースファイルを持つことができます。

リソースファイルは必須ではありませんが、言語毎にそのプラグイン情報を記述できます。

また、言語リソース(エラーメッセージなど)の追加・書き換えなどの動作も可能です。

リソースファイルは以下のように記述されます。

type[tab]管理用
name[tab]データ移行
text[tab]外部データ読み込みとデータ書出し
author[tab]takkyun
detail[tab]http://serennz.cool.ne.jp/sblog/
# resources
resource[tab]parts_import[tab]件のエントリーを取り込みました。
resource[tab]error_import_cond[tab]パスワードが設定されていません。
resource[tab]error_no_data[tab]読み込むデータがありません。

# [tab]はタブコードを示しています。グローバル環境設定の記述とは異なり、いわゆる半角スペースでは正しく認識されませんのでご注意ください。

name, text, author, detailはプラグイン情報として利用されます。admin moduleではnameが追加機能のメニュー名としても利用されます。

行頭に#がある行はコメント行として無視されます。

resourceは言語リソースとして追加する文字列を規定します。

resource[tab]label[tab]内容

のように記述され、sb::Language->get->string('label')で設定した文字列を呼び出すことができます。

リソースファイルの文字コードはプラグイン内に記述します。

文字コードはEUC-JP, Shift_JIS, iso-2022-jp, UTF-8が利用可能です。プラグインとリソースファイルの文字コードは同一に設定するようにしてください。

プラグインでは利用者がどの文字コードを利用しているかは基本的に意識する必要はありません。

ただし、外部ファイルの読込みやアクセスログの表示などソースとなるデータの文字コードが状況によって変化するような場合はこの限りではありません。

Serene Bachのプラグインではリソースファイルだけでなく、管理画面のテンプレートなどもリソースとしてプラグインディレクトリ内のリソースディレクトリに置くことができます。これらのファイルはSerene Bachで用意されているプラグインAPIを利用することで読み込むことができます。

リソースファイルはプラグインディレクトリ内にあるリソースディレクトリ内に置かれます。

日本語のリソースはplugin/resource/ja/に置かれ、言語に依存しないリソースはplugin/resource/に置かれることを想定しています。

plugin/
  Memo.pm
  resource/
    ja/
      memo.txt
      memo.html