README

This is a library of PHP Helper functions.

The main class is Tracker, which allows you to create code sections to track script times. It can also track changes in memory, and bandwidth.

The Tracker class uses a Singleton pattern to ensure a single global instance.

Installation

To include this package in your project, run the following command in your project's root directory:

composer require fofx/helper

The default configuration file path config/helper.config.php.

Docs

• For a detailed overview of the project structure and components, please see docs/project-structure.md.
• For detailed usage examples of the Tracker class, please see docs/Tracker.usage.md.
• For detailed documentation about the ReflectionUtils class and its methods, please see docs/ReflectionUtils.usage.md.

Tracker Usage

Below is a basic example from the public/index.php file:

require_once __DIR__ . "/../vendor/autoload.php";

use FOfX\Helper;
use FOfX\Helper\Tracker;

$tracker = Tracker::getInstance();
Helper\get_diagnostics();

// Create three code sections
$sections = array('1', '2', '3');
foreach ($sections as $i) {
    Tracker::scriptTimer("Section" . $i, "start");
    Helper\rand_sleep(.1);
    Tracker::scriptTimer("Section" . $i, "end");
}

// Print the section timer information arrays
Tracker::trackerEnd();

AutoStart

Alternatively, in config/helper.config.php you can set autoStartTracker to true. This will auto-start the Tracker global Singleton.

Since this can cause problems in testing environments, this will only work if is_phpunit_environment() returns false.

If autoStartTracker is enabled, you do not need to do $tracker = Tracker::getInstance();. The global Singleton will be initialized automatically during autoloading.

Testing and Development

To run the PHPUnit test suite through composer:

composer test

To use PHPStan for static analysis:

composer phpstan

To run PHPStan on the tests folder:

composer phpstan tests

To use PHP-CS-Fixer for code style:

composer cs-fix

PHPUnit Notes

Some tests require a web server. You can either use PHP's built-in server:

php -S localhost:8000 -t public/

Or use Laragon (Windows), Apache, Nginx, etc.

Note:

get_windows_memory_info() (in src/memory.php) uses shell_exec() to call PowerShell. This can cause font glitches in legacy CMD (conhost.exe).

If you run PHPUnit through legacy CMD, it may switch fonts. Use Terminal for PHPUnit instead.