pickles2/px2-px2dthelper v2.2.1 API Document

authorizer
in package

authorizer.php

Table of Contents

$authorization_table  : mixed
認可テーブル
$px  : mixed
Picklesオブジェクト
$role  : mixed
ロール名
get_role()  : string
ロール名を取得する
initialize()  : bool
$px->authorizer を生成する
is_authorized()  : bool
カレントユーザーに権限があるか確認する
__construct()  : mixed
Constructor

Properties

$authorization_table

認可テーブル

private mixed $authorization_table

Methods

get_role()

ロール名を取得する

public get_role() : string
Return values
string —

ロール名

initialize()

$px->authorizer を生成する

public static initialize(object $px[, string $role = null ]) : bool

Clover型のCMSでは、このメソッドは外部から $role を伴ってコールされます。 通常は、パラメータ $role は省略されます。 babycorn や Burdock のような、コマンドラインで呼び出す種類のCMSでは、 引数の代わりに、コマンドラインオプション --role でロール名を受け取ります。

この関数は、結果として $px->authorizer を生成します。 一度生成された $px->authorizer は、上書きできず、あとから状態を変更することはできません。

Parameters
$px : object

Picklesオブジェクト

$role : string = null

ロール名

Return values
bool —

成功時に true, 失敗時に false

is_authorized()

カレントユーザーに権限があるか確認する

public is_authorized(string $authority_name) : bool
Parameters
$authority_name : string

権限名

Return values
bool —

許可される場合に true, 許可されない場合 false

__construct()

Constructor

private __construct(object $px[, string $role = null ]) : mixed
Parameters
$px : object

$pxオブジェクト

$role : string = null

ロール名

Return values
mixed —

Search results