1. class
  2. Alxarafe
  3. \
  4. Core
  5. \
  6. Providers
  7. \
  8. DebugTool

DebugTool

class DebugTool

Class DebugTool

Traits

Singleton
Trait Singleton, This class ensures that all class that use this have only one instance of itself if called as: Class::getInstance()

Properties

static protected bool $singletonArray Set to true if you want use more that one singleton using and index param in getInstance from Singleton
static protected string $basePath The base path where config files are placed. from Singleton
static private string $className Name of the class from Singleton
static private array $instances Hold the classes on instance. from Singleton
protected bool $separateConfigFile Set to true if you want to save configuration in a separate file from Singleton
private StandardDebugBar $debugTool The debug bar.
private JavascriptRenderer $jsRender The JS renderer.
private Logger $logger The logger.

Methods

static DebugTool
getInstance()

Return this instance.

static string
getClassName()

Returns the class name.

from Singleton
bool
setConfig(array $params, bool $merge = true, string $index = 'main')

Save config to file.

from Singleton
array
getYamlContent()

Returns the content of the Yaml file.

from Singleton
string
getFilePath()

Return the full file config path.

from Singleton
string
getFileName()

Return the file name.

from Singleton
static string
yamlName()

Return the classname for yaml file.

from Singleton
bool
fileExists(string $filename)

Returns if file exists.

from Singleton
array
getConfig(string $index = 'main')

Returns the yaml config params.

from Singleton
static array
getDefaultValues()

Return default values

string
getBasePath()

Return the base path.

from Singleton
initSingleton()

Initialization, equivalent to __construct and must be called from main class.

from Singleton
__construct()

DebugTool constructor.

startTimer(string $name, string $message = 'Timer started')

Start a timer by name and message

addMessage(string $channel, string $message)

Write a message in a channel (tab) of the debug bar.

stopTimer(string $name)

Stop a timer by name.

addException(Exception $e)

Add a new exception to the debug bar.

StandardDebugBar
getDebugTool()

Return the internal debug instance.

string
getRenderHeader()

Return the render header needed when debug is enabled. Otherwise return an empty string.

string
getRenderFooter()

Return the render footer needed when debug is enabled. Otherwise return an empty string.

Details

at line 145
static DebugTool getInstance()

Return this instance.

Return Value

DebugTool

in Singleton at line 88
static private string getClassName()

Returns the class name.

Return Value

string

in Singleton at line 103
bool setConfig(array $params, bool $merge = true, string $index = 'main')

Save config to file.

Parameters

array $params
bool $merge
string $index

Return Value

bool

in Singleton at line 130
private array getYamlContent()

Returns the content of the Yaml file.

Return Value

array

in Singleton at line 152
string getFilePath()

Return the full file config path.

Return Value

string

in Singleton at line 162
string getFileName()

Return the file name.

Return Value

string

in Singleton at line 172
static string yamlName()

Return the classname for yaml file.

Return Value

string

in Singleton at line 184
protected bool fileExists(string $filename)

Returns if file exists.

Parameters

string $filename

Return Value

bool

in Singleton at line 196
array getConfig(string $index = 'main')

Returns the yaml config params.

Parameters

string $index

Return Value

array

at line 155
static array getDefaultValues()

Return default values

Return Value

array

in Singleton at line 215
string getBasePath()

Return the base path.

Return Value

string

in Singleton at line 223
protected initSingleton()

Initialization, equivalent to __construct and must be called from main class.

at line 54
__construct()

DebugTool constructor.

at line 87
startTimer(string $name, string $message = 'Timer started')

Start a timer by name and message

Parameters

string $name
string $message

at line 108
addMessage(string $channel, string $message)

Write a message in a channel (tab) of the debug bar.

Parameters

string $channel
string $message

at line 125
stopTimer(string $name)

Stop a timer by name.

Parameters

string $name

at line 166
addException(Exception $e)

Add a new exception to the debug bar.

Parameters

Exception $e

at line 184
StandardDebugBar getDebugTool()

Return the internal debug instance.

Return Value

StandardDebugBar

at line 194
string getRenderHeader()

Return the render header needed when debug is enabled. Otherwise return an empty string.

Return Value

string

at line 207
string getRenderFooter()

Return the render footer needed when debug is enabled. Otherwise return an empty string.

Return Value

string