\phpDocumentor\ConfigurationLogging

Configuration definition for the logger.

Summary

Methods
Properties
Constants
getLevel()
setLevel()
getPaths()
setPaths()
No public properties found
No constants found
No protected methods found
$level
$paths
N/A
No private methods found
No private properties found
N/A

Properties

$level

$level : string

Type

string — the minimum output level for logging.

$paths

$paths : array<mixed,string>

Type

array<mixed,string> — the paths determining where to output log files.

Methods

getLevel()

getLevel() : string

Returns the minimum output level for logging.

Returns

string

setLevel()

setLevel(string  $level) : void

Sets the minimum output level for the logger.

Parameters

string $level

getPaths()

getPaths() : array<mixed,string>

Returns the paths that determine where to store log files.

phpDocumentor uses two types of log files to be able to sift through the logs more easily:

  • 'default', contains all logs as mentioned in the logging level in this object and
  • 'debug', contains debugging information that is exposed when debugging is enabled.

Returns

array<mixed,string>

setPaths()

setPaths(array<mixed,\string>  $paths) : void

Registers the paths that determine where to store log files.

Parameters

array<mixed,\string> $paths