Documentation

message
in package
implements JsonSerializable Uses jsonSerializeReturnObject

View message object

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2020, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

since
4.4

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

ICON_ERROR  = 'exclamation-triangle'
ICON_NEUTRAL  = 'info-circle'
ICON_NOTICE  = 'check'
TYPE_ERROR  = 'error'
TYPE_NEUTRAL  = 'neutral'
TYPE_NOTICE  = 'notice'
$icon  : string
Message icon
$id  : string
Message id
$txt  : string
Message text
$type  : string
Message type
$webnotify  : bool
Use web notification
__construct()  : mixed
Constructor
getIcon()  : string
Return message icon
getId()  : string
Return message id
getTxt()  : string
Return message text
getType()  : string
Returns message type

Constants

ICON_ERROR

public mixed ICON_ERROR = 'exclamation-triangle'

ICON_NEUTRAL

public mixed ICON_NEUTRAL = 'info-circle'

ICON_NOTICE

public mixed ICON_NOTICE = 'check'

TYPE_ERROR

public mixed TYPE_ERROR = 'error'

TYPE_NEUTRAL

public mixed TYPE_NEUTRAL = 'neutral'

TYPE_NOTICE

public mixed TYPE_NOTICE = 'notice'

Properties

$icon

Message icon

private string $icon = ''

$id

Message id

private string $id = ''

$txt

Message text

private string $txt = ''

$type

Message type

private string $type = ''

$webnotify

Use web notification

private bool $webnotify = false

Methods

__construct()

Constructor

public __construct(string $txt, string $type[, string $icon = '' ][, string $id = '' ][, bool $webnotify = false ]) : mixed
Parameters
$txt : string
$type : string
$icon : string = ''
$id : string = ''
$webnotify : bool = false
Return values
mixed

getIcon()

Return message icon

public getIcon() : string
Return values
string

getId()

Return message id

public getId() : string
Return values
string

getTxt()

Return message text

public getTxt() : string
Return values
string

getType()

Returns message type

public getType() : string
Return values
string

Search results