Documentation

Message
in package

Description of Message

Tags
author

vitex

Table of Contents

$body  : string
Message body
$caller  : Atom
$type  : string
Message type
$when  : int
Message Timestamp
__construct()  : mixed
Basic Message class
getCallerName()  : string
Obtain object name from caller object
getTypeUnicodeSymbol()  : string
Unicode Symbol for given message type

Properties

$body

Message body

public string $body

$type

Message type

public string $type

info|succes|warning|error|mail|debug|event

$when

Message Timestamp

public int $when

Methods

__construct()

Basic Message class

public __construct(string $message[, string $type = 'info' ][, Atom|string $caller = null ][, int $when = null ]) : mixed
Parameters
$message : string

text

$type : string = 'info'

One of info|notice|debug|error

$caller : Atom|string = null

Origin of message

$when : int = null

Timestamp

Return values
mixed

getCallerName()

Obtain object name from caller object

public static getCallerName(object|string $caller) : string
Parameters
$caller : object|string
Return values
string

getTypeUnicodeSymbol()

Unicode Symbol for given message type

public static getTypeUnicodeSymbol(string $type[, mixed $color = true ]) : string
Parameters
$type : string

Type of message

$color : mixed = true
Return values
string

Search results