Documentation

Regent extends Atom
in package
implements Loggingable

Description of Regent

Tags
author

vitex

Interfaces, Classes, Traits and Enums

Loggingable

Table of Contents

$debug  : bool
Debug mode flag.
$loggers  : array<string|int, mixed>
Here to reach logger objects
$logStyles  : array<string|int, mixed>
Hodnoty pro obarvování logu.
$instance  : mixed
Saves obejct instace (singleton...).
$messages  : array<string|int, Message>
Keep All messages here
__construct()  : mixed
Allow to write logs to multiplete logging destinations
__toString()  : string
Magical function for all descendants (childern).
addStatusObject()  : int
Add Status Object to stack
addToLog()  : int
Add Status Message to all registered loggers
cleanMessages()  : mixed
Clean Internal message buffer
draw()  : string
Default draw method.
getMessages()  : array<string|int, Message>
Stored messages array
getObjectName()  : string
Returns object name
singleton()  : mixed
Get The Regent
takeMessage()  : mixed

Properties

$debug

Debug mode flag.

public bool $debug = false

$loggers

Here to reach logger objects

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

$logStyles

Hodnoty pro obarvování logu.

public array<string|int, mixed> $logStyles = ['notice' => 'color: black;', 'success' => 'color: #2C5F23;', 'message' => 'color: #2C5F23;', 'warning' => 'color: #AB250E;', 'error' => 'color: red;', 'debug' => 'font-style: italic;', 'report' => 'font-wight: bold;', 'event' => 'color: #996600; animation: animate 1.5s linear infinite; ', 'info' => 'color: blue;']

$instance

Saves obejct instace (singleton...).

private static mixed $instance = null

$messages

Keep All messages here

private array<string|int, Message> $messages = []

Methods

__construct()

Allow to write logs to multiplete logging destinations

public __construct([string|array<string|int, mixed> $logger = null ]) : mixed
Parameters
$logger : string|array<string|int, mixed> = null

class name

Return values
mixed

__toString()

Magical function for all descendants (childern).

public __toString() : string
Return values
string

addStatusObject()

Add Status Object to stack

public addStatusObject(Message $message) : int
Parameters
$message : Message
Return values
int

number of stored messages

addToLog()

Add Status Message to all registered loggers

public addToLog(object $caller, string $message[, string $type = 'info' ]) : int
Parameters
$caller : object

message provider

$message : string

message to log

$type : string = 'info'

info|succes|warning|error|email|...

Return values
int

How many loggers takes message

cleanMessages()

Clean Internal message buffer

public cleanMessages() : mixed
Return values
mixed

draw()

Default draw method.

public draw() : string
Return values
string

getMessages()

Stored messages array

public getMessages() : array<string|int, Message>
Return values
array<string|int, Message>

getObjectName()

Returns object name

public getObjectName() : string
Return values
string

singleton()

Get The Regent

public static singleton([mixed $loggers = [] ]) : mixed
Parameters
$loggers : mixed = []
Return values
mixed

takeMessage()

public takeMessage() : mixed
Return values
mixed

Search results