BcMessageComponent
extends Component
in package
uses
BcContainerTrait
Class BcMessageComponent 表示面へのメッセージをコントロールする為のコンポーネント
Table of Contents
Properties
- $components : array<string|int, mixed>
- $Flash : FlashComponent
Methods
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- hasService() : bool
- Has Service
- set() : mixed
- メッセージをセットする
- setError() : mixed
- 失敗メッセージをセットする
- setInfo() : mixed
- インフォメーションメッセージをセットする
- setSuccess() : mixed
- 成功メッセージをセットする
- setWarning() : mixed
- 警告メッセージをセットする
Properties
$components
public
array<string|int, mixed>
$components
= ['Flash']
$Flash
public
FlashComponent
$Flash
Methods
getService()
Get Service
public
getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
- $service : mixed
Tags
Return values
array<string|int, mixed>|mixed|objecthasService()
Has Service
public
hasService(mixed $service) : bool
Parameters
- $service : mixed
Tags
Return values
boolset()
メッセージをセットする
public
set(string $message[, bool $alert = false ][, bool $saveDblog = false ][, bool $setFlash = true ][, null|string $class = null ]) : mixed
Parameters
- $message : string
-
メッセージ
- $alert : bool = false
-
警告かどうか
- $saveDblog : bool = false
-
Dblogに保存するか
- $setFlash : bool = true
-
flash message に保存するか
- $class : null|string = null
-
付与するクラス名
Tags
setError()
失敗メッセージをセットする
public
setError(string $message[, bool $log = false ][, bool $setFlash = true ]) : mixed
Parameters
- $message : string
-
メッセージ
- $log : bool = false
-
DBログに保存するかどうか（初期値 : false）
- $setFlash : bool = true
-
フラッシュメッセージにセットするかどうか
Tags
setInfo()
インフォメーションメッセージをセットする
public
setInfo(string $message[, bool $log = false ][, bool $setFlash = true ]) : mixed
Parameters
- $message : string
-
メッセージ
- $log : bool = false
-
DBログに保存するかどうか（初期値 : false）
- $setFlash : bool = true
-
フラッシュメッセージにセットするかどうか
Tags
setSuccess()
成功メッセージをセットする
public
setSuccess(string $message[, bool $log = true ][, bool $setFlash = true ]) : mixed
Parameters
- $message : string
- $log : bool = true
-
DBログに保存するかどうか（初期値 : true）
- $setFlash : bool = true
Tags
setWarning()
警告メッセージをセットする
public
setWarning(string $message[, bool $log = false ][, bool $setFlash = true ]) : mixed
Parameters
- $message : string
-
メッセージ
- $log : bool = false
-
DBログに保存するかどうか（初期値 : false）
- $setFlash : bool = true
-
フラッシュメッセージにセットするかどうか