Interface: IDebugProfiler

Interface for debugging, tracing and profiling.

Extends

\SmartFactory\Interfaces\IInitable

Known implementations

\SmartFactory\DebugProfiler

Authors

Oleg Schildt

Package

System

Source code

SmartFactory/Interfaces/IDebugProfiler.php

 

Methods
public

Clears the specified log file.
public

Clears all log files.
public

Logs a message to a standard debug output.
public

Logs a message to a standard profiling output and shows the time elapsed since the last call startProfilePoint or fixProfilePoint.
public

Initializes the debug profiler with parameters.
public

Logs a message to a standard profiling output and stores the current time.

Method: IDebugProfiler::clearLogFile()

public function clearLogFile(string $file_name): void;

Clears the specified log file.

Parameters

Name Pass type Value type Default value Description
$file_name by value string

The target file name.

Returns

void

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/IDebugProfiler.php

See also

\SmartFactory\Interfaces\IDebugProfiler::clearLogFiles()

Method: IDebugProfiler::clearLogFiles()

public function clearLogFiles(): void;

Clears all log files.

Returns

void

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/IDebugProfiler.php

See also

\SmartFactory\Interfaces\IDebugProfiler::clearLogFile()

Method: IDebugProfiler::debugMessage()

public function debugMessage(string $message, bool $write_call_stack = false, string $file_name = "debug.log"): void;

Logs a message to a standard debug output.

Parameters

Name Pass type Value type Default value Description
$message by value string

Message to be logged.
$write_call_stack by value bool false

Flag that defines where the call stack should be written.
$file_name by value string "debug.log"

The target file name.

Returns

void

Throws

\Exception

It might throw an exception in the case of any errors.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/IDebugProfiler.php

Method: IDebugProfiler::fixProfilePoint()

public function fixProfilePoint(string $message): void;

Logs a message to a standard profiling output and shows the time elapsed since the last call startProfilePoint or fixProfilePoint.

Parameters

Name Pass type Value type Default value Description
$message by value string

Message to be logged.

Returns

void

Throws

\Exception

It might throw an exception in the case of any errors.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/IDebugProfiler.php

See also

\SmartFactory\Interfaces\IDebugProfiler::startProfilePoint()

Method: IDebugProfiler::init()

public function init(array $parameters): void;

Initializes the debug profiler with parameters.

Parameters

Name Pass type Value type Default value Description
$parameters by value array

The parameters may vary for each debug profiler.

Returns

void

Throws

\Exception

It might throw an exception in the case of any system errors.

Overrides

\SmartFactory\Interfaces\IInitable::init()

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/IDebugProfiler.php

Method: IDebugProfiler::startProfilePoint()

public function startProfilePoint(string $message): void;

Logs a message to a standard profiling output and stores the current time.

Parameters

Name Pass type Value type Default value Description
$message by value string

Message to be logged.

Returns

void

Throws

\Exception

It might throw an exception in the case of any errors.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/IDebugProfiler.php

See also

\SmartFactory\Interfaces\IDebugProfiler::fixProfilePoint()