Page MenuHomeDevCentral

Offer debugger methods to dump a variable
ClosedPublic

Authored by dereckson on Apr 18 2018, 19:00.

Details

Summary

Import dprint_r and dieprint_r to the library.

These functions allow to enclose a print_r call in a preformatted block,
so the output could be read directly in a rendered HTML document.

They are intended to be used as debug time.

As these global functions are still in use during some current debug
and development tasks, we offer a mechanism to register them from the
Debugger class. As create_function is deprecated since PHP 7.2.0,
the selected method is to require a wrapper file in the global space.

The result is a choice between those two syntaxes:

Debugger::register();
dprint_r($someVariable);
Debugger::printVariable($someVariable);

Ref T1395

Test Plan
  • unit test provided for the registration
  • integration tests provided for the debug methods

Diff Detail

Repository
rKOT Keruald OmniTools
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

dereckson requested review of this revision.Apr 18 2018, 19:00
dereckson created this revision.
dereckson updated this revision to Diff 4123.Apr 18 2018, 19:15

Declare in phpcs configuration file we don't need to check camel case for _register_to_global_space.php functions

dereckson updated this revision to Diff 4128.Apr 20 2018, 11:59

Integration tests

dereckson edited the summary of this revision. (Show Details)Apr 20 2018, 12:04
dereckson edited the test plan for this revision. (Show Details)
dereckson edited the summary of this revision. (Show Details)
dereckson edited the summary of this revision. (Show Details)
dereckson accepted this revision.Apr 20 2018, 12:07
This revision is now accepted and ready to land.Apr 20 2018, 12:07
This revision was automatically updated to reflect the committed changes.