BcAuthHelper
extends Helper
in package
uses
BcEventDispatcherTrait
Class BcAuthHelper
Tags
Attributes
- #[AllowDynamicProperties]
Table of Contents
Properties
- $BcBaser : BcBaserHelper
- $helpers : array<string|int, mixed>
- Helper
- $_View : View
- View
Methods
- dispatchLayerEvent() : bool|Event
- イベントを発火
- getCurrentLoginRedirectUrl() : mixed
- 現在のログイン後のリダイレクトURL
- getCurrentLoginUrl() : string
- 現在の認証プレフィックスのログインURLを取得
- getCurrentLoginUser() : EntityInterface
- 現在のログインユーザー
- getCurrentLogoutUrl() : mixed
- 現在のログアウトURL
- getCurrentName() : mixed
- 認証名を取得する フロントの場合はサイト名
- getCurrentPrefix() : string
- 現在認証プレフィックスを取得する
- getCurrentPrefixSetting() : array<string|int, mixed>
- 現在の認証プレフィックスの設定を取得
- getCurrentUserPrefixes() : array<string|int, mixed>
- 現在のユーザーに許可された認証プレフィックスを取得する
- getLoginUrl() : string
- 認証プレフィックスのログインURLを取得
- getLogoutUrl() : mixed
- ログアウトURLを取得する
- getPrefixSetting() : array<string|int, mixed>|array<string|int, false>|mixed
- 認証プレフィックスの設定を取得
- isAdminLogin() : bool
- 管理画面にログインしているかどうか
- isAdminUser() : bool
- 管理ユーザログイン状態判別
- isAgentUser() : bool
- 代理ログイン状態判別
- isCurrentUserAdminAvailable() : bool
- 現在のユーザーが管理画面の利用が許可されているかどうか
- isSuperUser() : bool
- 特権ユーザログイン状態判別
Properties
$BcBaser
public
BcBaserHelper
$BcBaser
$helpers
Helper
public
array<string|int, mixed>
$helpers
= ['BaserCore.BcBaser']
$_View
View
protected
View
$_View
Methods
dispatchLayerEvent()
イベントを発火
public
dispatchLayerEvent(string $name[, array<string|int, mixed> $data = [] ][, mixed $options = [] ]) : bool|Event
Parameters
- $name : string
- $data : array<string|int, mixed> = []
- $options : mixed = []
Tags
Return values
bool|EventgetCurrentLoginRedirectUrl()
現在のログイン後のリダイレクトURL
public
getCurrentLoginRedirectUrl() : mixed
Tags
getCurrentLoginUrl()
現在の認証プレフィックスのログインURLを取得
public
getCurrentLoginUrl() : string
Tags
Return values
stringgetCurrentLoginUser()
現在のログインユーザー
public
getCurrentLoginUser() : EntityInterface
Tags
Return values
EntityInterfacegetCurrentLogoutUrl()
現在のログアウトURL
public
getCurrentLogoutUrl() : mixed
Tags
getCurrentName()
認証名を取得する フロントの場合はサイト名
public
getCurrentName() : mixed
Tags
getCurrentPrefix()
現在認証プレフィックスを取得する
public
getCurrentPrefix() : string
Tags
Return values
string —currentPrefix
getCurrentPrefixSetting()
現在の認証プレフィックスの設定を取得
public
getCurrentPrefixSetting() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —認証プレフィックス設定
getCurrentUserPrefixes()
現在のユーザーに許可された認証プレフィックスを取得する
public
getCurrentUserPrefixes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getLoginUrl()
認証プレフィックスのログインURLを取得
public
getLoginUrl(mixed $prefix) : string
Parameters
- $prefix : mixed
Tags
Return values
stringgetLogoutUrl()
ログアウトURLを取得する
public
getLogoutUrl(mixed $prefix[, mixed $isConverted = false ]) : mixed
Parameters
- $prefix : mixed
- $isConverted : mixed = false
Tags
getPrefixSetting()
認証プレフィックスの設定を取得
public
getPrefixSetting(mixed $prefix) : array<string|int, mixed>|array<string|int, false>|mixed
Parameters
- $prefix : mixed
Tags
Return values
array<string|int, mixed>|array<string|int, false>|mixedisAdminLogin()
管理画面にログインしているかどうか
public
isAdminLogin() : bool
Tags
Return values
boolisAdminUser()
管理ユーザログイン状態判別
public
isAdminUser() : bool
Tags
Return values
boolisAgentUser()
代理ログイン状態判別
public
isAgentUser() : bool
Tags
Return values
boolisCurrentUserAdminAvailable()
現在のユーザーが管理画面の利用が許可されているかどうか
public
isCurrentUserAdminAvailable() : bool
Tags
Return values
boolisSuperUser()
特権ユーザログイン状態判別
public
isSuperUser() : bool