BcWidgetAreaControllerEventListener
extends BcControllerEventListener
in package
BcWidgetAreaControllerEventListener
Table of Contents
- $events : array<string|int, string>
- Events
- $layer : string
- レイヤー名
- $plugin : string
- プラグイン名
- __construct() : mixed
- コンストラクタ
- addHelper() : mixed
- コントローラーにヘルパーを追加する
- getAction() : string
- 現在のアクションを特定する文字列を取得する
- implementedEvents() : array<string|int, mixed>
- implementedEvents
- isAction() : bool
- 指定した文字列が現在のアクションとしてみなされるかどうか判定する
- setAdminCurrentSite() : bool
- 管理システムの現在のサイトをセットする
- startup() : mixed
- Startup
Properties
$events
Events
public
array<string|int, string>
$events
= ['startup']
$layer
レイヤー名
public
string
$layer
= ''
$plugin
プラグイン名
public
string
$plugin
= ''
Methods
__construct()
コンストラクタ
public
__construct() : mixed
Return values
mixed —addHelper()
コントローラーにヘルパーを追加する
public
addHelper(Controller $controller, string|array<string|int, mixed> $helper) : mixed
Parameters
- $controller : Controller
- $helper : string|array<string|int, mixed>
Tags
Return values
mixed —getAction()
現在のアクションを特定する文字列を取得する
public
getAction([bool $isContainController = true ]) : string
Parameters
- $isContainController : bool = true
-
コントローラー名を含むかどうか(初期値:true)
Return values
string —implementedEvents()
implementedEvents
public
implementedEvents() : array<string|int, mixed>
Return values
array<string|int, mixed> —isAction()
指定した文字列が現在のアクションとしてみなされるかどうか判定する
public
isAction(string $action[, bool $isContainController = true ]) : bool
コントローラー名、アクション名をキャメルケースに変換する前提で、ドットで結合した文字列とする (例)Users.AdminIndex
Parameters
- $action : string
-
アクションを特定する為の文字列
- $isContainController : bool = true
-
コントローラー名を含むかどうか(初期値:true)
Return values
bool —setAdminCurrentSite()
管理システムの現在のサイトをセットする
public
setAdminCurrentSite(Controller $controller, $siteId) : bool
Parameters
Tags
Return values
bool —startup()
Startup
public
startup(Event $event) : mixed
Parameters
- $event : Event