BcControllerEventListener
extends BcEventListener
in package
Class BcControllerEventListener
コントローラーイベントリスナー
Controllerイベントにコールバック処理を登録するための継承用クラス。 events プロパティに配列で、イベント名を登録する。 イベント名についてレイヤー名は省略できる。 コールバック関数はイベント名より .（ドット）をアンダースコアに置き換えた上でキャメルケースに変換したものを 同クラス内のメソッドとして登録する
（例） Controller.Dashboard.beforeRendr に対してコールバック処理を登録
public $events = array('Dashboard.beforeRender'); public function dashboardBeforeRender($event) }
Table of Contents
Properties
Methods
- __construct() : mixed
- コンストラクタ
- addHelper() : mixed
- コントローラーにヘルパーを追加する
- getAction() : string
- 現在のアクションを特定する文字列を取得する
- implementedEvents() : array<string|int, mixed>
- implementedEvents
- isAction() : bool
- 指定した文字列が現在のアクションとしてみなされるかどうか判定する
- setAdminCurrentSite() : bool
- 管理システムの現在のサイトをセットする
Properties
$events
登録イベント
public
array<string|int, mixed>
$events
= []
$layer
レイヤー名
public
string
$layer
= 'Controller'
$plugin
プラグイン名
public
string
$plugin
= ''
Methods
__construct()
コンストラクタ
public
__construct() : mixed
Tags
addHelper()
コントローラーにヘルパーを追加する
public
addHelper(Controller $controller, string|array<string|int, mixed> $helper) : mixed
Parameters
- $controller : Controller
- $helper : string|array<string|int, mixed>
Tags
getAction()
現在のアクションを特定する文字列を取得する
public
getAction([bool $isContainController = true ]) : string
Parameters
- $isContainController : bool = true
-
コントローラー名を含むかどうか（初期値：true）
Tags
Return values
stringimplementedEvents()
implementedEvents
public
implementedEvents() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>isAction()
指定した文字列が現在のアクションとしてみなされるかどうか判定する
public
isAction(string $action[, bool $isContainController = true ]) : bool
コントローラー名、アクション名をキャメルケースに変換する前提で、ドットで結合した文字列とする （例）Users.AdminIndex
Parameters
- $action : string
-
アクションを特定する為の文字列
- $isContainController : bool = true
-
コントローラー名を含むかどうか（初期値：true）
Tags
Return values
boolsetAdminCurrentSite()
管理システムの現在のサイトをセットする
public
setAdminCurrentSite(Controller $controller, $siteId) : bool