Logger implements LoggerInterface uses LoggerTrait, ToStringTrait

A simple PSR-3-compliant file-based logger.

use oihana\logging\Logger;

$logger = new Logger(__DIR__ . '/logs', Logger::DEBUG);

$logger->info('Application started');
$logger->error('An error occurred: {error}', ['error' => $exception->getMessage()]);

Table of Contents

Interfaces

LoggerInterface

Constants

ALERT  = 1

CRITICAL  = 2

DEBUG  = 7

EMERGENCY  = 0

Error severity, from low to high. From BSD syslog RFC, section 4.1.1

ERROR  = 3

ERROR_DIR_WRITE_FAILED  = 'dir:write:failed'

ERROR_FILE_OPEN_FAILED  = 'fil:open:failed'

ERROR_FILE_OPEN_SUCCESS  = 'fil:open:success'

ERROR_FILE_PERMISSION_FAILED  = 'fil:permission:failed'

ERROR_FILE_WRITE_FAILED  = 'fil:write:failed'

INFO  = 6

LEVELS  = [\Psr\Log\LogLevel::EMERGENCY => self::EMERGENCY, \Psr\Log\LogLevel::ALERT => self::ALERT, \Psr\Log\LogLevel::CRITICAL => self::CRITICAL, \Psr\Log\LogLevel::ERROR => self::ERROR, \Psr\Log\LogLevel::WARNING => self::WARNING, \Psr\Log\LogLevel::NOTICE => self::NOTICE, \Psr\Log\LogLevel::INFO => self::INFO, \Psr\Log\LogLevel::DEBUG => self::DEBUG]

NOTICE  = 5

OFF  = 8

STATUS_LOG_CLOSED  = 3

STATUS_LOG_OPEN  = 1

Internal status codes

STATUS_OPEN_FAILED  = 2

WARNING  = 4

Properties

$extension  : string

$fileDateFormat  : string

$prefix  : string

$_dateFormat  : string

Valid PHP date() format string for log timestamps

$_defaultPermissions  : int

Octal notation for default permissions of the log file

$_defaultSeverity  : int

Default severity of log messages, if not specified

$_file  : resource

This holds the file handle for this instance's log file

$buffer  : array<string|int, mixed>

Holds messages generated by the class

$directory  : string

The directory to the log file

$errors  : array<string|int, mixed>

Standard messages produced by the class. Can be modified for il8n

$path  : string|null

Path to the log file

$severityThreshold  : int

Current minimum logging threshold

$status  : int

Current status of the log file

Methods

__construct()  : void

Creates a new Logger instance.

__destruct()  : void

Destruct the instance.

__toString()  : string

Returns a String representation of the object.

clear()  : void

Clear all logs in the log path.

createPath()  : string

Creates the log file path with a specific name.

getDirectory()  : string

Returns the directory of the logs files.

getErrors()  : array<string|int, mixed>

Returns the entire message queue (leaving it intact)

getLogFiles()  : array<string|int, mixed>

Returns the list of all log files in the logger directory.

getMessage()  : string

Returns (and removes) the last message from the queue buffer.

getPath()  : string

Returns the path of the logs files.

getStatus()  : int

Indicates the status of the logger instance.

log()  : void

Writes a message to the log with the given severity.

onError()  : true

Invoked when a global error is sending.

onException()  : true

Invoked when a global exception is sending.

writeFreeFormLine()  : void

Writes a line to the log without prepending a status or timestamp.

getErrorMessage()  : string

Returns an error message with a specific error status.