a-blog cms PHP API Reference

Role extends General
in package

Table of Contents

Properties

$attached  : array<string|int, mixed>
$cache  : array<string|int, mixed>
$ignoreBlogScope  : bool

Methods

checkShortcut()  : bool
ログインしているユーザーが特定の管理ページで権限があるかチェック
getAuthorizedBlog()  : array<string|int, mixed>
指定したユーザーの権限があるブログリストを取得
isAdministrator()  : bool
指定したユーザーが管理者か
isContributor()  : bool
指定したユーザーが投稿者か
isControlBlog()  : bool
ログイン中のユーザーがそのブログにおいて権限があるか
isEditor()  : bool
指定したユーザーが編集者か
isPermissionOfAdministrator()  : bool
ログイン中のユーザーがそのブログにおいて管理者以上の権限があるか
isPermissionOfContributor()  : bool
ログイン中のユーザーがそのブログにおいて投稿者以上の権限があるか
isPermissionOfEditor()  : bool
ログイン中のユーザーがそのブログにおいて編集者以上の権限があるか
isPermissionOfSnsLogin()  : bool
指定したユーザーがSNSログインを利用できるか
isPermissionOfSubscriber()  : bool
ログイン中のユーザーがそのブログにおいて読者以上の権限があるか
isSubscriber()  : bool
指定ユーザーが読者か
roleAuthorization()  : bool
各ロールの権限があるかチェック
setIgnoreBlogScope()  : void
cacheAttached()  : bool|mixed
cacheMethod()  : mixed
getRole()  : array<string|int, mixed>
ロールを取得
getUserGroup()  : false|array<string|int, mixed>
ログイン中ユーザーの所属ユーザーグループの取得
isAuthAction()  : bool
アクションに対する権限がロールにあるかチェック
isControlBlogByRole()  : bool
このブログに対するアクセス権限がロールにあるかチェック

Properties

$attached

protected array<string|int, mixed> $attached = []

$cache

protected array<string|int, mixed> $cache = []

$ignoreBlogScope

protected bool $ignoreBlogScope = false

Methods

checkShortcut()

ログインしているユーザーが特定の管理ページで権限があるかチェック

public checkShortcut(array<string|int, mixed> $ids) : bool
Parameters
$ids : array<string|int, mixed>
Tags
inheritDoc
Return values
bool

getAuthorizedBlog()

指定したユーザーの権限があるブログリストを取得

public getAuthorizedBlog(int $uid) : array<string|int, mixed>
Parameters
$uid : int
Return values
array<string|int, mixed>

isAdministrator()

指定したユーザーが管理者か

public isAdministrator([int|null $uid = SUID ]) : bool
Parameters
$uid : int|null = SUID
Return values
bool

isContributor()

指定したユーザーが投稿者か

public isContributor([int|null $uid = SUID ]) : bool
Parameters
$uid : int|null = SUID
Return values
bool

isControlBlog()

ログイン中のユーザーがそのブログにおいて権限があるか

public isControlBlog(int $bid) : bool
Parameters
$bid : int
Return values
bool

isEditor()

指定したユーザーが編集者か

public isEditor([int|null $uid = SUID ]) : bool
Parameters
$uid : int|null = SUID
Return values
bool

isPermissionOfAdministrator()

ログイン中のユーザーがそのブログにおいて管理者以上の権限があるか

public isPermissionOfAdministrator([int|null $bid = BID ]) : bool
Parameters
$bid : int|null = BID
Return values
bool

isPermissionOfContributor()

ログイン中のユーザーがそのブログにおいて投稿者以上の権限があるか

public isPermissionOfContributor([int|null $bid = BID ]) : bool
Parameters
$bid : int|null = BID
Return values
bool

isPermissionOfEditor()

ログイン中のユーザーがそのブログにおいて編集者以上の権限があるか

public isPermissionOfEditor([int|null $bid = BID ]) : bool
Parameters
$bid : int|null = BID
Return values
bool

isPermissionOfSnsLogin()

指定したユーザーがSNSログインを利用できるか

public isPermissionOfSnsLogin([int|null $uid = SUID ][, int|null $bid = BID ]) : bool
Parameters
$uid : int|null = SUID
$bid : int|null = BID
Return values
bool

isPermissionOfSubscriber()

ログイン中のユーザーがそのブログにおいて読者以上の権限があるか

public isPermissionOfSubscriber([int|null $bid = BID ]) : bool
Parameters
$bid : int|null = BID
Return values
bool

isSubscriber()

指定ユーザーが読者か

public isSubscriber([int|null $uid = SUID ]) : bool
Parameters
$uid : int|null = SUID
Return values
bool

roleAuthorization()

各ロールの権限があるかチェック

public roleAuthorization(mixed $action[, mixed $bid = BID ][, mixed $eid = 0 ][, mixed $uid = SUID ]) : bool
Parameters
$action : mixed
$bid : mixed = BID
$eid : mixed = 0
$uid : mixed = SUID
Tags
inheritDoc
Return values
bool

setIgnoreBlogScope()

public setIgnoreBlogScope([bool $ignore = true ]) : void
Parameters
$ignore : bool = true

cacheAttached()

protected cacheAttached(mixed $method) : bool|mixed
Parameters
$method : mixed
Return values
bool|mixed

cacheMethod()

protected cacheMethod(mixed $method[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$method : mixed
$args : array<string|int, mixed> = []

getRole()

ロールを取得

protected getRole(int $ugid) : array<string|int, mixed>
Parameters
$ugid : int
Return values
array<string|int, mixed>

getUserGroup()

ログイン中ユーザーの所属ユーザーグループの取得

protected getUserGroup([int $uid = SUID ]) : false|array<string|int, mixed>
Parameters
$uid : int = SUID
Return values
false|array<string|int, mixed>

isAuthAction()

アクションに対する権限がロールにあるかチェック

protected isAuthAction(array<string|int, mixed> $role, string $action, int $eid) : bool
Parameters
$role : array<string|int, mixed>
$action : string
$eid : int
Return values
bool

isControlBlogByRole()

このブログに対するアクセス権限がロールにあるかチェック

protected isControlBlogByRole(array<string|int, mixed> $role, int $bid) : bool
Parameters
$role : array<string|int, mixed>
$bid : int
Return values
bool

        
On this page

Search results