Work on #324.

[mjordan]

Github issue: (#324)

What does this Pull Request do?

Adds a utility class "Dumper" that lets you dump the value of a variable to a file.

A new class, src/utilities/Dumper, that provides a single method, ->dump().

How should this be tested?

• Check out the issue-324 branch.
• Run composer dump-autoload or equivalent on your system.
• Instantiate a new dumper by adding the following lines to the mik script at line 235:

$dumper = new \mik\utilities\Dumper();
$dumper->dump($record, 'Record', '/tmp/foo.txt');

• Run mik using any working .ini file.
• The file /tmp/foo.txt should contain the dumped data.
• Open mik and delete the '/tmp/foo.txt' from the dumper parameters.
• Rerun MIK.
• The file /tmp/mik_dumper.txt should contain the dumped data.

Additional Notes

@MarcusBarnes any thoughts on how I've set up the new 'utilities' namespace, etc.?

We can document how this utility works on the Information for Developer page.

Interested parties

@MarcusBarnes

[MarcusBarnes]

Appears to work as described. Thank you @mjordan. When documenting, we should include a link to the PHP sys_get_temp_dir function documentation, as the default temporary folder may vary considerably based on one's PHP environment.

[mjordan]

Cookbook entry is at https://github.com/MarcusBarnes/mik/wiki/Cookbook:-Inspecting-a-variable's-value.