plugindev:actionlog

ACTIONLOGクラス リファレンス

ACTIONLOGクラスは管理操作履歴の管理を行うためのメソッドを提供するクラスです。このクラスはv3.24現在、nucleus/libs/ACTIONLOG.phpで定義されています。

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

メソッド一覧(一部)

リファレンス

add

void ACTIONLOG::add(int level, string message)

管理操作履歴にメッセージを追加する

管理操作履歴にメッセージを追加します。

最初の引数levelのために定数が用意されています。以下その定数のリストです。

  1. ERROR (エラーの表示にのみ使える)
  2. WARNING (エラー・警告の表示にのみ使える)
  3. INFO (エラー・警告・通知のために使える)
  4. DEBUG (何でもあり)

これらの定数は上にあるものほど重要度が高く設定されています。

グローバル変数$CONF['LogLevel']もこれら定数のいずれかの値をとっていて、その値より重要度が低いメッセージは保存そのものが行われません

実行時に時刻と、メンバーの名前(ログインしている場合のみ)が同時に記録されます。

  • 戻り値
    • なし
  • パラメータ
    1. int level : メッセージの重要度
    2. string message : 保存するメッセージ

グローバルファンクションにショートカット関数addToLogが用意されています。

clear

void ACTIONLOG::clear()

管理操作履歴を削除する

管理操作履歴を全て削除します。また、削除にイベントActionLogClearedが呼ばれます。

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

trimLog

void ACTIONLOG::trimLog()

古いメッセージを削除する

管理操作履歴のメッセージが500件を超えていたとき、250件まで削除します。addメソッド中でコールされます。

処理が行われるのはスクリプト実行中で一回のみです。

  • 戻り値
    • なし
  • パラメータ
    • なし
 
plugindev/actionlog.txt · 最終更新: 2011/03/23 21:28 (外部編集)