baserCMS クラスリファレンス

BcEventListener
in package
implements EventListenerInterface

Class BcEventListener

イベントリスナー

イベントにコールバック処理を登録するための継承用クラス。 events プロパティに配列で、イベント名を登録する。 イベント名についてレイヤー名は省略できる。 コールバック関数はイベント名より .(ドット)をアンダースコアに置き換えた上でキャメルケースに変換したものを 同クラス内のメソッドとして登録する

(例) View.beforeRendr に対してコールバック処理を登録

public $events = array('beforeRender'); public function beforeRender($event) }

Table of Contents

Interfaces

EventListenerInterface

Properties

$events  : array<string|int, mixed>
登録イベント
$layer  : string
レイヤー名
$plugin  : string
プラグイン名

Methods

__construct()  : mixed
コンストラクタ
getAction()  : string
現在のアクションを特定する文字列を取得する
implementedEvents()  : array<string|int, mixed>
implementedEvents
isAction()  : bool
指定した文字列が現在のアクションとしてみなされるかどうか判定する

Properties

$events

登録イベント

public array<string|int, mixed> $events = []

Methods

__construct()

コンストラクタ

public __construct() : mixed
Tags
checked
noTodo
unitTest

getAction()

現在のアクションを特定する文字列を取得する

public getAction([bool $isContainController = true ]) : string
Parameters
$isContainController : bool = true

コントローラー名を含むかどうか(初期値:true)

Tags
checked
noTodo
unitTest
Return values
string

implementedEvents()

implementedEvents

public implementedEvents() : array<string|int, mixed>
Tags
checked
noTodo
unitTest
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
checked
noTodo
unitTest
Return values
bool

        
On this page

Search results