Midari Create > webアプリケーション製品 > Wakarana > 関数マニュアル >

class wakarana_permitted_value

wakarana_data_itemの派生クラス。権限値の情報を読み書きするために使用する。1インスタンスごとに1権限値の情報が割り当てられる。

wakarana_permitted_value::__construct($wakarana, $permitted_value_info)

コンストラクタ。wakarana::get_permitted_valueの実行時に呼び出されるものであり、直接インスタンス化するべきではない。

$wakarana : 呼び出し元のwakaranaインスタンス
$permitted_value_info : 権限値情報("permitted_value_id"(権限値ID)、"permitted_value_name"(権限値名)、"permitted_value_description"(権限値の説明文))を格納した連想配列

wakarana_permitted_value::get_id()

権限値のIDを取得する。

返り値 : 権限値のIDを返す。

wakarana_permitted_value::get_name()

権限値の表示名を取得する。

返り値 : 権限値の表示名を返す。

wakarana_permitted_value::get_description()

権限値の説明文を取得する。

返り値 : 権限値についての説明文を返す。

wakarana_permitted_value::set_info($permitted_value_name=NULL, $permitted_value_description=NULL)

権限値の情報を変更する。

$permitted_value_name : 権限値の表示名。変更しない場合はNULL。
$permitted_value_description : 権限値についての説明文。変更しない場合は省略。

返り値 : 成功した場合はTRUE、失敗した場合はFALSEを返す。

wakarana_permitted_value::get_roles($min=NULL, $max=NULL)

権限値が割り当てられているロールの一覧を取得する。

$min : 取得対象にする権限値の下限。NULLの場合は下限を設けない。
$max : 取得対象にする権限値の上限。NULLの場合は上限を設けない。

返り値 : ロールとその権限値を格納した連想配列("role"(ロールのwakarana_roleインスタンス)、"permitted_value"(権限値))を権限値の大きい順に並べた配列を返す。権限値を持つロールが存在しなければ空配列を返し、失敗した場合はFALSEを返す。

wakarana_permitted_value::get_users($min=NULL, $max=NULL)

権限値が割り当てられているユーザーの一覧を取得する。

$min : 取得対象にする権限値の下限。NULLの場合は下限を設けない。
$max : 取得対象にする権限値の上限。NULLの場合は上限を設けない。

返り値 : ユーザーとその権限値を格納した連想配列("user"(ユーザーのwakarana_userインスタンス)、"permitted_value"(権限値))を権限値の大きい順に並べた配列を返す。権限値を持つユーザーが存在しなければ空配列を返し、失敗した場合はFALSEを返す。

wakarana_permitted_value::delete_permitted_value()

権限値を全てのロールから剥奪して完全に削除する。

返り値 : 成功した場合はTRUE、失敗した場合はFALSEを返す。