CodeIgniter v4.6 API

MockFileLogger extends FileHandler
in package

Extends FileHandler, exposing some inner workings

Table of Contents

Properties

$destination  : string
Where would the log be written?
$dateFormat  : string
Date format for logging
$fileExtension  : string
Extension to use for log files
$filePermissions  : int
Permissions for new log files
$handles  : array<int, string>
Handles
$path  : string
Folder to hold logs

Methods

__construct()  : mixed
canHandle()  : bool
Checks whether the Handler will handle logging items of this log Level.
handle()  : bool
Handles logging the message.
setDateFormat()  : HandlerInterface
Stores the date format to use while logging messages.

Properties

$destination

Where would the log be written?

public string $destination

$dateFormat

Date format for logging

protected string $dateFormat = 'Y-m-d H:i:s'

$fileExtension

Extension to use for log files

protected string $fileExtension

$filePermissions

Permissions for new log files

protected int $filePermissions

$handles

Handles

protected array<int, string> $handles

Methods

__construct()

public __construct(array{handles?: list, path?: string, fileExtension?: string, filePermissions?: int} $config) : mixed
Parameters
$config : array{handles?: list, path?: string, fileExtension?: string, filePermissions?: int}

canHandle()

Checks whether the Handler will handle logging items of this log Level.

public canHandle(string $level) : bool
Parameters
$level : string
Return values
bool

handle()

Handles logging the message.

public handle(string $level, string $message) : bool

If the handler returns false, then execution of handlers will stop. Any handlers that have not run, yet, will not be run.

Parameters
$level : string
$message : string
Tags
throws
Exception
Return values
bool

        
On this page

Search results