DolLogsCollector Class Reference

DolLogsCollector class. More...

Inheritance diagram for DolLogsCollector:

Collaboration diagram for DolLogsCollector:

Public Member Functions
	__construct ($path=null, $name='logs')
	Constructor.
	getWidgets ()
	Return widget settings.
	collect ()
	Return collected data.
	getLogsFile ()
	Get the path to the logs file.
	getStorageLogs ($path)
	Get logs.
	getLogs ($file)
	Search a string for log entries into the log file.
	getLevels ()
	Get the log levels from psr/log.

Protected Member Functions
	tailFile ($file, $lines)
	Get latest file lines.

Detailed Description

DolLogsCollector class.

Definition at line 34 of file DolLogsCollector.php.

Constructor & Destructor Documentation

__construct()

DolLogsCollector::__construct	(		$path = null,
			$name = 'logs' )

Constructor.

Parameters

string	$path	Path
string	$name	Name

Definition at line 56 of file DolLogsCollector.php.

References getDolGlobalInt(), and getLogsFile().

Member Function Documentation

collect()

DolLogsCollector::collect

(

)

Return collected data.

Returns

array{count:int,messages:string[]} Array of collected data

Definition at line 98 of file DolLogsCollector.php.

References $conf, getDolGlobalInt(), getLevels(), and getStorageLogs().

getLevels()

DolLogsCollector::getLevels

(

)

Get the log levels from psr/log.

Returns

array<string,string> Array of log level

Definition at line 226 of file DolLogsCollector.php.

Referenced by collect(), and getLogs().

getLogs()

DolLogsCollector::getLogs

(

$file

)

Search a string for log entries into the log file.

Used when debug bar scan log file (very slow).

Parameters

string

$file

File

Returns

list<array{level:string,line:string}> Lines of log entries

Definition at line 201 of file DolLogsCollector.php.

References getLevels().

Referenced by getStorageLogs().

getLogsFile()

DolLogsCollector::getLogsFile

(

)

Get the path to the logs file.

Returns

string

Definition at line 131 of file DolLogsCollector.php.

Referenced by __construct().

getStorageLogs()

DolLogsCollector::getStorageLogs

(

$path

)

Get logs.

Parameters

string

$path

Path

Returns

void

Definition at line 144 of file DolLogsCollector.php.

References getLogs(), and tailFile().

Referenced by collect().

getWidgets()

DolLogsCollector::getWidgets

(

)

Return widget settings.

Returns

array<string,array{icon?:string,indicator?:string,widget?:string,tooltip?:string|array{html:string,class:string},map:string,default:string}> Array

Definition at line 72 of file DolLogsCollector.php.

tailFile()

DolLogsCollector::tailFile ( $file, $lines )

protected

Get latest file lines.

Parameters

string	$file	File
int	$lines	Lines

Returns

string[] Array

Definition at line 165 of file DolLogsCollector.php.

Referenced by getStorageLogs().

---

The documentation for this class was generated from the following file:

• dolibarr_dev/htdocs/debugbar/class/DataCollector/DolLogsCollector.php