Arikaim CMS

Logger
in package
implements LoggerInterface

Logger

Table of Contents

Interfaces

LoggerInterface
Logger interface

Constants

DEFAULT_HANDLER  = 'file'

Properties

$enabled  : bool
Enable/Disable logger
$logger  : Logger
Logger object
$handerNames  : array<string|int, mixed>
Handler names
$handlerName  : string|null
Current handler name
$logsDir  : string|null
Logs directory

Methods

__call()  : bool
Call logger function
__construct()  : mixed
Constructor
createHandler()  : HandlerInterface
Create handler instance
deleteSystemLogs()  : bool
Delete logs file
disable()  : void
Disable logger
error()  : bool
Add error log
getHandelerName()  : string
Get handler name
getHandlerNames()  : array<string|int, mixed>
Get handler names
getHandlers()  : array<string|int, mixed>
Get handler
getLogger()  : Logger
Return stats logger
getLogsFileName()  : string
Get logs file name
info()  : bool
Add info log
isValidHandlerName()  : bool
Return true if handler name is valid
log()  : bool
Add log record
popHandler()  : HandlerInterface
Pop handler
pushHandler()  : void
Push handler
readSystemLogs()  : array<string|int, mixed>
Read logs file with paginator
setHandler()  : void
Replace all handlers with one
setHandlers()  : void
Set handlers
setLogger()  : void
Set logger
deleteLogs()  : bool
Delete logs

Constants

DEFAULT_HANDLER

public mixed DEFAULT_HANDLER = 'file'

Properties

$enabled

Enable/Disable logger

protected bool $enabled

$logger

Logger object

protected Logger $logger

$handerNames

Handler names

private array<string|int, mixed> $handerNames = ['db', 'file']

$handlerName

Current handler name

private string|null $handlerName

$logsDir

Logs directory

private string|null $logsDir

Methods

__call()

Call logger function

public __call(string $name, mixed $arguments) : bool
Parameters
$name : string
$arguments : mixed
Return values
bool

__construct()

Constructor

public __construct(string|null $logsDir, bool $enabled[, string|null $handlerName = Self::DEFAULT_HANDLER ]) : mixed
Parameters
$logsDir : string|null
$enabled : bool
$handlerName : string|null = Self::DEFAULT_HANDLER

createHandler()

Create handler instance

public createHandler(string $name) : HandlerInterface
Parameters
$name : string
Tags
throws
Exception
Return values
HandlerInterface

deleteSystemLogs()

Delete logs file

public deleteSystemLogs() : bool
Return values
bool

disable()

Disable logger

public disable() : void

error()

Add error log

public error(string $message[, array<string|int, mixed> $context = [] ]) : bool
Parameters
$message : string
$context : array<string|int, mixed> = []
Return values
bool

getHandelerName()

Get handler name

public getHandelerName() : string
Return values
string

getHandlerNames()

Get handler names

public getHandlerNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHandlers()

Get handler

public getHandlers() : array<string|int, mixed>
Return values
array<string|int, mixed>

getLogger()

Return stats logger

public getLogger() : Logger
Return values
Logger

getLogsFileName()

Get logs file name

public getLogsFileName() : string
Return values
string

info()

Add info log

public info(string $message[, array<string|int, mixed> $context = [] ]) : bool
Parameters
$message : string
$context : array<string|int, mixed> = []
Return values
bool

isValidHandlerName()

Return true if handler name is valid

public isValidHandlerName(string $name) : bool
Parameters
$name : string
Return values
bool

log()

Add log record

public log(string $level, string $message[, array<string|int, mixed> $context = [] ]) : bool
Parameters
$level : string
$message : string
$context : array<string|int, mixed> = []
Return values
bool

popHandler()

Pop handler

public popHandler() : HandlerInterface
Return values
HandlerInterface

pushHandler()

Push handler

public pushHandler(string $name) : void
Parameters
$name : string

readSystemLogs()

Read logs file with paginator

public readSystemLogs() : array<string|int, mixed>
Return values
array<string|int, mixed>

setHandler()

Replace all handlers with one

public setHandler(string $name) : void
Parameters
$name : string

setHandlers()

Set handlers

public setHandlers(array<string|int, mixed> $handlers) : void
Parameters
$handlers : array<string|int, mixed>

setLogger()

Set logger

public setLogger(Logger $logger) : void
Parameters
$logger : Logger

deleteLogs()

Delete logs

protected deleteLogs(object $handler) : bool
Parameters
$handler : object
Return values
bool

        
On this page

Search results