plugindev:manager

MANAGERクラス リファレンス

MANAGERクラスはブログやアイテム、プラグイン等の情報をメモリ上に保持するためのオブジェクトを定義するクラスです。v3.24現在、このクラスはnucleus/libs/MANAGER.phpで定義されています。

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

MANAGERオブジェクトの取得方法

システム全体で使用するMANAGERオブジェクトを単一に限定するために、グローバル変数の$managerを使用します。

singletonパターンを意識したメソッドinstanceが用意されていますが、PHP4ではうまく動作しません。

メソッド一覧(一部)

A-Z順

用途別

リファレンス

instance

MANAGER MANAGER::instance()

MANAGERオブジェクトを返す

singletonパターン実現のために用意されたメソッドですが、PHP4ではうまく動作しません。使用しないほうが無難なメソッドです。

  • 戻り値
    • MANAGERオブジェクト
  • パラメータ
    • なし

getItem

array MANAGER::getItem(int itemid, bool allowdraft, bool allowfuture)

アイテムID等の条件からアイテム情報が入った配列への参照を返す

条件に合致するアイテムの情報が収められた配列への参照を返します。

条件に合致するアイテムが存在しない場合、0が返されます。

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

  • 戻り値
    • アイテムが存在する場合その情報が入った配列への参照。そうでなければ0。
  • パラメータ
    1. int itemid : アイテムID
    2. bool allowdraft : ドラフト状態のアイテムを返すかどうか
    3. bool allowfuture : 未来の投稿時刻を持ったアイテムを返すかどうか

loadClass

void MANAGER::loadClass(string name)

名前からコアで用意されたクラスをロードする

引数で指定された名前のクラスがロードされていない場合、対応するNucleusコアのファイルをincludeしてそのクラスをロードします。

  • 戻り値
    • なし
  • パラメータ
    1. string name : ロードするクラスの名前

existsItem

bool MANAGER::existsItem(int itemid, bool allowdraft, bool allowfuture)

アイテムID等の条件からアイテムの存在をチェックする

引数で指定された条件に合致するアイテムの存在を確認します。

存在する場合trueが、しない場合falseが返されます。

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

  • 戻り値
    • アイテムが存在する場合true。そうでなければfalse
  • パラメータ
    1. int itemid : アイテムID
    2. bool allowdraft : ドラフト状態のアイテムを返すかどうか
    3. bool allowfuture : 未来の投稿時刻を持ったアイテムを返すかどうか

existsCategory

bool MANAGER::existsCategory(int id)

カテゴリーIDからカテゴリーの存在をチェックする

データベースの情報を確認し、引数で与えられたIDを持つカテゴリーが存在すればtrueを、そうでなければfalseを返します。

  • 戻り値
    • カテゴリーが存在する場合true、そうでなければfalse
  • パラメータ
    1. int id : カテゴリーID

getBlog

BLOG MANAGER::getBlog(int blogid)

ブログIDからブログオブジェクトへの参照を返す

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

  • 戻り値
    • BLOGオブジェクトへの参照
  • パラメータ
    1. int blogid : ブログID

existsBlog

bool MANAGER::existsBlog(string name)

ブログの名前からブログの存在をチェックする

データベースの情報を確認し、引数で与えられた名前に対応するブログの存在をチェックします。

存在する場合trueが、しない場合falseが返されます。

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

  • 戻り値
    • ブログが存在する場合true、そうでなければfalse
  • パラメータ
    1. string name : ブログの名前

existsBlogid

bool MANAGER::existsBlogid(int id)

ブログIDからブログの存在をチェックする

データベースの情報を確認し、引数で与えられたブログIDに対応するブログの存在をチェックします。

存在する場合trueが、しない場合falseが返されます。

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

  • 戻り値
    • ブログが存在する場合true、そうでなければfalse
  • パラメータ
    1. int id : ブログID

getTemplate

array MANAGER::getTemplate(string templateName)

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

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

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

getKarma

KARMA &MANAGER::getKarma(int itemid)

アイテムIDからKarmaオブジェクトへの参照を返す

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

  • 戻り値
    • KARMAオブジェクトへの参照
  • パラメータ
    1. int itemid : アイテムID

setParserProperty

void MANAGER::setParserProperty(string name, mixed value)

パーサで使用する値のセット

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

  • 戻り値
    • なし
  • パラメータ
    1. string name : プロパティの名前
    2. mixed value : プロパティの値

getParserProperty

mixed MANAGER::getParserProperty(string name)

パーサで使用する値を返す

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

  • 戻り値
  • パラメータ
    1. string name : プロパティの名前

getPlugin

NucleusPlugin MANAGER::getPlugin(string name)

プラグインの名前からプラグインオブジェクトへの参照を返す

引数nameは完全なプラグインの名前です。たとえばNP_HelloWorldの場合、NP_HelloWorldそのままを使用します。

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

  • 戻り値
    • NucleusPluginオブジェクトへの参照
  • パラメータ
    1. string name : プラグインの名前

pluginInstalled

bool MANAGER::pluginInstalled(string name)

プラグインの名前からプラグインがインストールされているかどうかチェックする

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

  • 戻り値
    • インストールされている場合true, されていない場合false
  • パラメータ
    1. string name : プラグインの名前

pidInstalled

bool MANAGER::pidInstalled(int pid)

プラグインIDからプラグインがインストールされているかどうかチェックする

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

  • 戻り値
    • インストールされている場合true, されていない場合false
  • パラメータ
    1. int pid : プラグインID

getPidFromName

int MANAGER::getPidFromName(string name)

プラグインの名前からプラグインIDを返す

プラグインがインストールされていない場合-1が返されます。

逆関数に相当するものがグローバルファンクションに用意されています→getPluginNameFromPid

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

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

clearCachedInfo

void MANAGER::clearCachedInfo(string what)

MANAGERオブジェクトが管理するメモリ上のキャッシュを消去

MANAGERが管理するメモリ上のキャッシュを消去します。

v3.23現在は

unset($this->cachedInfo[$what]);

とされているだけです。

引数whatの値は自由ですが、コアファイルでは'installedPlugins'(プラグインがインストールされているかどうかの情報)のみが使用されています。

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

  • 戻り値
    • なし
  • パラメータ
    1. string what : キャッシュの種類

notify

void MANAGER::notify(string eventName, array data)

イベントを発生させる

PreItemなどのイベントを発生させます。それぞれのイベントについての詳細はNucleusプラグインイベント リファレンス (カテゴリ別)を参照してください。

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

  • 戻り値
    • なし
  • パラメータ
    1. string eventName : イベントの名前
    2. array data : イベントで使用する配列

addTicketToUrl

string MANAGER::addTicketToUrl(string url)

渡されたURLに新しく生成したチケットの情報を付加して返す

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

  • 戻り値
    • チケットの情報が付加されたURL
  • パラメータ
    1. string url : チケット情報を付加させたいURL

addTicketHidden

void MANAGER::addTicketHidden()

新しく生成したチケットの情報が収められた(X)HTMLのinput要素を出力する

出力されるタグは以下のようになります。

<input type="hidden" name="ticket" value="(チケット)" />

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

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

checkTicket

bool MANAGER::checkTicket()

正しいチケット情報が使用されているかどうかチェックする

リクエスト変数を確認して、正しいチケットの情報が含まれていればtrueを、そうでなければfalseを返します。

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

  • 戻り値
    • 正しいチケット情報があればtrue、なければfalse
  • パラメータ
    • なし
 
plugindev/manager.txt · 最終更新: 2011/03/23 21:28 (外部編集)