TEMPLATEはテンプレートをあらわすクラスです。v3.24現在、このクラスはnucleus/libs/TEMPLATE.phpで定義されています。
間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。
TEMPLATE TEMPLATE::TEMPLATE(int templateid)
コンストラクタです。
int TEMPLATE::getID()
テンプレートIDを返します。
このメソッドは、スタティックにコールすることはできません。
TEMPLATE TEMPLATE::createFromName(string name)
指定されたテンプレート名に対応したTEMPLATEオブジェクトを返します。
int TEMPLATE::getIdFromName(string name)
指定されたテンプレート名に対応したテンプレートIDを返します。
void TEMPLATE::updateGeneralInfo(string name, string desc)
テンプレート情報を更新します。
更新されるのはテンプレート名、およびテンプレートの説明です。
テンプレート名に使用可能な文字列が指定されているかどうかは判定されません。isValidTemplateNameを使用してください。
テンプレート名の重複については判定されません。TEMPLATE::existsを使用してください。
このメソッドは、スタティックにコールすることはできません。
void TEMPLATE::update(string type, string content)
テンプレートの内容を更新します。
typeに更新を行う部分の名前、contentにその内容を指定します。contentが空の場合、その部分の内容は単に削除されます。
このメソッドは、スタティックにコールすることはできません。
void TEMPLATE::deleteAllParts()
テンプレートの内容を削除します。
このメソッドは、スタティックにコールすることはできません。
int TEMPLATE::createNew(string name, string desc)
指定されたパラメータを元にテンプレートを作成します。
テンプレート名に使用可能な文字列が指定されているかどうかは判定されません。isValidTemplateNameを使用してください。
テンプレート名の重複については判定されません。TEMPLATE::existsを使用してください。
このメソッド内で以下のイベントが実行されます。
array TEMPLATE::read(string name)
指定された名前に対応したテンプレートの情報が入った配列を返します。
配列は連想配列になっており、キーが部分の名前、値がその内容になっています。
また、このメソッド内で日時のロケールがテンプレートで指定されたものに設定されます。
MANAGER::getTemplateも参照してください。
string TEMPLATE::fill(string template, array values)
templateで指定された文字列中に<%...%>で囲まれた部分がある場合、それを置き換えたものを返します。
置き換えに使う値はvaluesで指定します。valuesは連想配列です。文字列中の”<%(配列のキー)%>”が”(その値)“に変更されます。
文字列がvaluesのキーに指定されていない場合、その部分は削除されます(ただしその文字列がa-zA-Zで構成されている場合)。
bool TEMPLATE::exists(string name)
指定された文字列を名前に持つテンプレートの存在をチェックします。
bool TEMPLATE::existsID(int id)
指定された数字をIDに持つテンプレートの存在をチェックします。
string TEMPLATE::getNameFromID(int id)
指定されたテンプレートIDに対応したテンプレート名を返します。
string TEMPLATE::getDesc(int id)
指定されたテンプレートIDに対応したテンプレートの説明を返します。
