a-blog cms PHP API Reference

Authorization
in package

フォーム機能の認可判定を集約する。

ロール運用時は form_view / form_edit ロール、未使用時はフォーム管理セッションで判定する。 各ハンドラ(ACMS_POST_Form_* / ACMS_GET_Admin_Form_*)から共通利用する。

判定対象のユーザーは引数で受け取り、テスト時に任意のユーザーを差し込めるようにする (ロール運用の判定はユーザーを基準に行う。ロール未使用時のセッション判定は アクセス中のユーザーが対象となる)。ロール判定はガード選択がセッションユーザー(SUID) 基準となる Auth ファサードではなく、ロールガードを直接利用することで、 引数で受け取ったユーザーを基準に評価する。

Table of Contents

Methods

canDeleteLog()  : bool
フォームの投稿ログ削除が許可されているか
canEdit()  : bool
フォームの編集・作成・削除・複製・インポートが許可されているか
canView()  : bool
フォームの閲覧・エクスポートが許可されているか
canViewLog()  : bool
フォームの投稿ログ閲覧が許可されているか
roleGuard()  : Guard
ロールベースの権限判定ガードを取得する。

Methods

canDeleteLog()

フォームの投稿ログ削除が許可されているか

public canDeleteLog(int|null $userId, int $blogId) : bool

編集系(canEdit)と異なり、ロール未使用時はフォーム管理権限ではなく ブログ管理者権限(sessionWithAdministration)を要求する。

Parameters
$userId : int|null

判定対象のユーザーID(通常はログイン中のユーザー SUID。未ログイン時は null)

$blogId : int

対象ブログID

Return values
bool

canEdit()

フォームの編集・作成・削除・複製・インポートが許可されているか

public canEdit(int|null $userId, int $blogId) : bool
Parameters
$userId : int|null

判定対象のユーザーID(通常はログイン中のユーザー SUID。未ログイン時は null)

$blogId : int

対象ブログID

Return values
bool

canView()

フォームの閲覧・エクスポートが許可されているか

public canView(int|null $userId, int $blogId) : bool
Parameters
$userId : int|null

判定対象のユーザーID(通常はログイン中のユーザー SUID。未ログイン時は null)

$blogId : int

対象ブログID

Return values
bool

canViewLog()

フォームの投稿ログ閲覧が許可されているか

public canViewLog(int|null $userId, int $blogId) : bool

閲覧系(canView)と異なり、ロール運用時は form_view 権限のみで判定する (form_edit だけのユーザーにはログを開放しない)。

Parameters
$userId : int|null

判定対象のユーザーID(通常はログイン中のユーザー SUID。未ログイン時は null)

$blogId : int

対象ブログID

Return values
bool

roleGuard()

ロールベースの権限判定ガードを取得する。

private roleGuard() : Guard

Auth ファサードはガード選択をセッションユーザー(SUID)基準で行うため、 引数で受け取ったユーザーを基準に判定するにはロールガードを直接利用する。 roleAvailableUser() が真のユーザーに対してのみ呼ばれるため、本番では Auth ファサード経由(ロールユーザーは同じくロールガードに振られる)と同一の結果になる。

Return values
Guard

        
On this page

Search results