PHP code example of jcm / footprint-php

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

jcm / footprint-php example snippets

 declare(strict_types = 1);

   //For the main Tracker instance
use Footprint\Modules\ChartJS;     //Tracker module
use Footprint\Modules\Memory;      //Tracker module
use Footprint\Modules\Time;        //Tracker module

class SomeClassName 
{
    public function testMethod() {
        $mem = str_repeat("X", 1024 * 1024); //We create a variable using certain memory size
        
        $moduleTime = new Time();  //Create instance of the Time module
        $moduleMem = new Memory(); //Create instance of the Memory module
        
        /**
         * We create an instance of the ChartJS module
         * and we also specify the name of the output file that it will generate for us
         */
        $moduleChartJS = new ChartJS("report.html");

        /**
         * Module ChartJS needs to know in advance which "Tracker keys" will
         * consider at the moment of generating the chart for us.
         * 
         * You can read more about this in the Wiki section, but basically we are adding all
         * the keys used in the Memory and Time modules.
         */
        foreach($moduleMem->getKeys() as $key) {
            $moduleChartJS->addKey($key);
        }

        foreach($moduleTime->getKeys() as $key) {
            $moduleChartJS->addKey($key);
        }
        
        $tracker = new Tracker(); //Main Tracker instance
        
        /**
         * We load the previously created modules into the Tracker.
         * 
         * The Tracker is the main actor in all this scenario.
         * 
         * The Tracker will use the modules properly.
         */
        $tracker->loadModule($moduleMem);
        $tracker->loadModule($moduleTime);
        $tracker->loadModule($moduleChartJS);
        
        $tracker->init(); //Start the Tracker
        
        $tracker->log(); //We do our first log
        
        /**
         * Now we will ...
         * 1) Increase the memory use by the $mem variable
         * 2) Make some sleeps to generate a delay
         * 
         * All these is done trying to simulate a real php code execution, that uses
         * different amount of memory and time execution.
         * 
         */

        $mem = str_repeat($mem, 2); //We duplicate the size of memory use by variable $mem
        
        sleep(1); //Wait 1 second
        
        $tracker->log(); //Log again
        
        sleep(2);
        
        $mem = str_repeat($mem, 2);
        
        $tracker->log();
        
        sleep(1);
        
        $mem = str_repeat("XXX", 2000);
        
        $tracker->log();
        
        /**
         * When we get to the point we dont want to track anymore, then we finalize tracking calling
         * the end() method of the Tracker.
         */
        $tracker->end();
    }
}

$testClass = new SomeClassName();

$testClass->testMethod();

echo "End here";

composer 

Using version ^1.1 for jcm/footprint-php
./composer.json has been updated
Running composer update jcm/footprint-php
Loading composer repositories with package information
Updating dependencies
Lock file operations: 1 install, 0 updates, 0 removals
  - Locking jcm/footprint-php (v1.1)
Writing lock file
Installing dependencies from lock file (including