baserCMS クラスリファレンス

BcWidgetAreaHelper extends Helper
in package
Uses BcEventDispatcherTrait, BcContainerTrait

ウィジェットエリアヘルパー

Table of Contents

$BcBaser  : BcBaserHelper
$helpers  : array<string|int, string>
Helper
$_View  : View
View
dispatchLayerEvent()  : bool|Event
イベントを発火
getService()  : array<string|int, mixed>|mixed|object
Get Service
getWidgetArea()  : string
ウィジェットエリアを取得する
hasService()  : bool
Has Service
show()  : mixed
ウィジェットエリアを表示する
widgetArea()  : void
ウィジェットエリアを出力する

Properties

$helpers

Helper

public array<string|int, string> $helpers = ['BaserCore.BcBaser']

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
checked
unitTest
noTodo
Return values
bool|Event

getService()

Get Service

public getService( $service) : array<string|int, mixed>|mixed|object
Parameters
$service :
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>|mixed|object

getWidgetArea()

ウィジェットエリアを取得する

public getWidgetArea([int $no = null ][, array<string|int, mixed> $options = [] ]) : string
Parameters
$no : int = null

ウィジェットエリアNO(初期値 : null)※ 省略した場合は、コンテンツごとに管理システムにて設定されているウィジェットエリアを出力する

$options : array<string|int, mixed> = []

オプション(初期値 : array())

Return values
string

hasService()

Has Service

public hasService( $service) : bool
Parameters
$service :
Tags
checked
noTodo
unitTest
Return values
bool

show()

ウィジェットエリアを表示する

public show(int $no[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$no : int

ウィジェットエリアNO

$options : array<string|int, mixed> = []

オプション subDir (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照

Return values
mixed

widgetArea()

ウィジェットエリアを出力する

public widgetArea([int $no = null ][, array<string|int, mixed> $options = [] ]) : void
Parameters
$no : int = null

ウィジェットエリアNO(初期値 : null)※ 省略した場合は、コンテンツごとに管理システムにて設定されているウィジェットエリアを出力する

$options : array<string|int, mixed> = []

オプション(初期値 : array())

Return values
void

Search results