API Documentation
\

\log

Summary

Methods
Properties
Constants
getConfig()
getLogger()
getLogLevel()
convertLogLevel()
add()
chunk()
chunkLog()
getPathToLog()
authorizeClearLog()
clear()
clearAll()
remove()
removeAll()
get()
getDelta()
getLastLine()
liste()
define_error_reporting()
exception()
No public properties found
DEFAULT_MAX_LINE
No protected methods found
No protected properties found
N/A
No private methods found
$logger
$config
N/A

Constants

DEFAULT_MAX_LINE

DEFAULT_MAX_LINE =200

Properties

$logger

$logger :

Type

$config

$config :

Type

Methods

getConfig()

getConfig(  $_key,  $_default = '')

Parameters

$_key
$_default

getLogger()

getLogger(  $_log)

Parameters

$_log

getLogLevel()

getLogLevel(  $_log)

Parameters

$_log

convertLogLevel()

convertLogLevel(  $_level = 100)

Parameters

$_level

add()

add(  $_log,string  $_type,string  $_message,  $_logicalId = '')

Add message and keep it less than 1000 lines

Parameters

$_log
string $_type

message type (info, debug, warning, danger)
string $_message

message added into log
$_logicalId

chunk()

chunk(  $_log = '')

Parameters

$_log

chunkLog()

chunkLog(  $_path)

Parameters

$_path

getPathToLog()

getPathToLog(  $_log = 'core')

Parameters

$_log

authorizeClearLog()

authorizeClearLog(  $_log,  $_subPath = '')

Check authorisation to emptying log file

Parameters

$_log
$_subPath

clear()

clear(  $_log)

Empty log file

Parameters

$_log

clearAll()

clearAll()

remove()

remove(  $_log)

Delete log file

Parameters

$_log

removeAll()

removeAll()

get()

get(string  $_log,integer  $_begin,integer  $_nbLines): boolean|array

Get $_nbLines from a $_log from $_begin position

Parameters

string $_log
integer $_begin
integer $_nbLines

Returns

boolean|array

getDelta()

getDelta(string  $_log = 'core',integer  $_position,string  $_search = '',integer  $_colored = false,boolean  $_numbered = true,integer  $_numStart,integer  $_max = 4000): array

Get the log delta from $_position to the end of the file New position is stored in $_position when eof is reached

Parameters

string $_log

Log filename (default 'core')
integer $_position

Bytes representing position from the begining of the file (default 0)
string $_search

Text to find in log file (default '')
integer $_colored

Should lines be colored (default false)
boolean $_numbered

Should lines be numbered (default true)
integer $_numStart

At what number should lines number start (default 0)
integer $_max

Max number of returned lines (default 4000)

Returns

array —

Array containing log to append to buffer and new position for next call

getLastLine()

getLastLine(string  $_log): string

Efficiently get the last line of a file

Parameters

string $_log

Log filename

Returns

string —

The last non-empty line of the file (or '')

liste()

liste(  $_filtre = null)

Parameters

$_filtre

define_error_reporting()

define_error_reporting(integer  $log_level)

Set php error level

Parameters

integer $log_level

exception()

exception(  $e)

Parameters

$e