KinoWiki.net

プラグイン > API > Pageクラス

プラグイン/API/Pageクラス

説明

Pageクラスはページ1つを表します。特定のページの情報を取得・変更したい場合はこのクラスを使います。

インスタンスを取得するときはgetinstance()かgetinstancebynum()を使います。コンストラクタを直接使うことはありません。

メンバ関数

static function getinstance($pagename)
ページ名からインスタンスを取得します。
static function getinstancebynum($num)
ページ番号からインスタンスを取得します。
function getpagename()
ページ名を取得します。
function getnum()
ページ番号を取得します。存在しないページの場合はnullを返します。
function getsource($num = 0)
本文を取得します。引数に1以上を指定した場合、バックアップからの取得になります。
function gettimestamp($num = 0)
タイムスタンプを取得します。このタイムスタンプは投稿時の「タイムスタンプを更新しない」を反映します。引数に1以上を指定した場合、バックアップからの取得になります。
function getrealtimestamp($num = 0)
投稿時の時刻を取得します。これは「タイムスタンプを更新しない」にかかわらず、投稿時刻を記録しています。引数に1以上を指定した場合、バックアップからの取得になります。
function isexist($num = 0)
ページが存在する(本文が空でない)場合にtrueを返します。
function write($source, $notimestamp = false)
本文を書き換えます。書き換え前の本文はバックアップに移されます。$notimestampがtrueの時、「タイムスタンプを更新しない」の動きになります。
function deletebackup()
このページのバックアップを全て削除します。
function getbackupamount()
バックアップの数を取得します。
function getbackup()
バックアップを全て取得します。返値はpagebackupテーブルの内容を新しい順に並べて格納した2次元配列です。
function equals($page)
引数に指定したインスタンスと自分自身とが同じページの時trueを返します。
Pageクラスは厳密にはシングルトンではないため、同じページを表す2つのインスタンスができることがあります(データはDBを介して同期されます)。
function ishidden()
隠しページの場合trueを返します。
function isnull()
ページ名が空文字列の場合にtrueを返します。
static function attach($obj)
いずれかのPageインスタンスに変更が加わった場合(本文が書き換わった場合)に通知を受け取るインスタンスを登録します。登録するインスタンスはMyObserverインターフェースを実装してください。
PageインスタンスではなくPageクラスへの登録になるので、ページ名を指定して登録することはできません。
static function detach($obj)
attach()したインスタンスを登録抹消します。

注意

ページ名が空文字列のページにはデータを格納しないでください。そのページはnull値の代わりに使用する(予定な)ので、内容が保証されません。