Documentation

File extends AbstractWriter
in package

File log writer class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.0.0

Table of Contents

Properties

$file  : string|null
Log file
$limit  : int|null
Log limit
$type  : string|null
Log file type

Methods

__construct()  : mixed
Constructor
getContext()  : string
Get context for log
getFile()  : string
Get file
getLogLimit()  : int|null
Get log limit
getType()  : string|null
Get type
hasLogLimit()  : bool
Has log limit
isWithinLogLimit()  : bool
Check if a log level is within the set log level limit
setLogLimit()  : AbstractWriter
Set log limit
writeLog()  : File
Write to the log

Properties

$file

Log file

protected string|null $file = null

$type

Log file type

protected string|null $type = null

Methods

__construct()

Constructor

public __construct(string $file) : mixed

Instantiate the file writer object

Parameters
$file : string

getContext()

Get context for log

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

getFile()

Get file

public getFile() : string
Return values
string

getLogLimit()

Get log limit

public getLogLimit() : int|null
Return values
int|null

getType()

Get type

public getType() : string|null
Return values
string|null

hasLogLimit()

Has log limit

public hasLogLimit() : bool
Return values
bool

isWithinLogLimit()

Check if a log level is within the set log level limit

public isWithinLogLimit(int $level) : bool
Parameters
$level : int
Return values
bool

writeLog()

Write to the log

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

        
On this page

Search results