plugindev:template

TEMPLATEクラス リファレンス

TEMPLATEはテンプレートをあらわすクラスです。v3.24現在、このクラスはnucleus/libs/TEMPLATE.phpで定義されています。

間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。

メソッド一覧

リファレンス

TEMPLATE

TEMPLATE TEMPLATE::TEMPLATE(int templateid)

コンストラクタ

コンストラクタです。

  • 戻り値
    • TEMPLATEオブジェクト
  • パラメータ
    1. int templateid : テンプレートID

getID

int TEMPLATE::getID()

テンプレートIDを返す

テンプレートIDを返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • テンプレートID
  • パラメータ
    • なし

createFromName

TEMPLATE TEMPLATE::createFromName(string name)

名前からTEMPLATEオブジェクトを作成する

指定されたテンプレート名に対応したTEMPLATEオブジェクトを返します。

  • 戻り値
    • TEMPLATEオブジェクト
  • パラメータ
    1. string name : テンプレートの名前

getIdFromName

int TEMPLATE::getIdFromName(string name)

名前からテンプレートIDを返す

指定されたテンプレート名に対応したテンプレートIDを返します。

  • 戻り値
    • テンプレートID
  • パラメータ
    1. string name : テンプレートの名前

updateGeneralInfo

void TEMPLATE::updateGeneralInfo(string name, string desc)

テンプレートの情報を更新する

テンプレート情報を更新します。

更新されるのはテンプレート名、およびテンプレートの説明です。

テンプレート名に使用可能な文字列が指定されているかどうかは判定されません。isValidTemplateNameを使用してください。

テンプレート名の重複については判定されません。TEMPLATE::existsを使用してください。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. string name : 新しく設定されるテンプレートの名前
    2. string desc : 新しく設定されるテンプレートの説明

update

void TEMPLATE::update(string type, string content)

テンプレートの内容を更新する

テンプレートの内容を更新します。

typeに更新を行う部分の名前、contentにその内容を指定します。contentが空の場合、その部分の内容は単に削除されます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. string type : 新しく設定される部分の名前
    2. string content : 新しく設定される部分の内容

deleteAllParts

void TEMPLATE::deleteAllParts()

テンプレートの内容を全て削除する

テンプレートの内容を削除します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    • なし

createNew

int TEMPLATE::createNew(string name, string desc)

新しいテンプレートを作成する

指定されたパラメータを元にテンプレートを作成します。

テンプレート名に使用可能な文字列が指定されているかどうかは判定されません。isValidTemplateNameを使用してください。

テンプレート名の重複については判定されません。TEMPLATE::existsを使用してください。

このメソッド内で以下のイベントが実行されます。

  • 戻り値
    • 新しく作成されたテンプレートのテンプレートID
  • パラメータ
    1. string name : 新しく作成するテンプレートの名前
    2. string desc : 新しく作成するテンプレートの説明

read

array TEMPLATE::read(string name)

テンプレートの名前からテンプレート情報が入った配列を返す

指定された名前に対応したテンプレートの情報が入った配列を返します。

配列は連想配列になっており、キーが部分の名前、値がその内容になっています。

また、このメソッド内で日時のロケールがテンプレートで指定されたものに設定されます。

MANAGER::getTemplateも参照してください。

  • 戻り値
    • テンプレートの情報が入った配列。
  • パラメータ
    1. string name : テンプレートの名前

fill

string TEMPLATE::fill(string template, array values)

指定されたテンプレートを指定された値で埋める

templateで指定された文字列中に<%…%>で囲まれた部分がある場合、それを置き換えたものを返します。

置き換えに使う値はvaluesで指定します。valuesは連想配列です。文字列中の"<%(配列のキー)%>"が"(その値)"に変更されます。

文字列がvaluesのキーに指定されていない場合、その部分は削除されます(ただしその文字列がa-zA-Zで構成されている場合)。

  • 戻り値
    • 変換後の文字列
  • パラメータ
    1. string template : 値を埋め込むテンプレート
    2. array values : 値を指定する配列

exists

bool TEMPLATE::exists(string name)

名前からテンプレートの存在をチェックする

指定された文字列を名前に持つテンプレートの存在をチェックします。

  • 戻り値
    • 存在する場合真、存在しない場合偽
  • パラメータ
    1. string name : テンプレートの名前

existsID

bool TEMPLATE::existsID(int id)

IDからテンプレートの存在をチェックする

指定された数字をIDに持つテンプレートの存在をチェックします。

  • 戻り値
    • 存在する場合真、存在しない場合偽
  • パラメータ
    1. int id : テンプレートID

getNameFromID

string TEMPLATE::getNameFromID(int id)

テンプレートIDから名前を返す

指定されたテンプレートIDに対応したテンプレート名を返します。

  • 戻り値
    • テンプレート名
  • パラメータ
    1. int id : テンプレートID

getDesc

string TEMPLATE::getDesc(int id)

テンプレートIDから説明を返す

指定されたテンプレートIDに対応したテンプレートの説明を返します。

  • 戻り値
    • テンプレートの説明
  • パラメータ
    1. int id : テンプレートID
 
plugindev/template.txt · 最終更新: 2011/03/23 21:28 (外部編集)