asad/benchmark

Micro PHP library for benchmarking

1.0.5 2020-05-09 12:16 UTC

This package is auto-updated.

Last update: 2024-10-09 21:49:31 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads License

This package only for the Laravel App. If you want to use this package in non-laravel App then use this Ubench

Requirements

Installation

You can install the package via composer:

composer require asad/benchmark

Usage

use Asad\Bench\Benchmark;

$bench = new Benchmark();

$bench->start();

// Execute some code

$bench->end();

// Get elapsed time and memory
echo $bench->getTime(); // 156ms or 1.123s
echo $bench->getTime(true); // elapsed microtime in float
echo $bench->getTime(false, '%d%s'); // 156ms or 1s

echo $bench->getMemoryPeak(); // 152B or 90.00Kb or 15.23Mb
echo $bench->getMemoryPeak(true); // memory peak in bytes
echo $bench->getMemoryPeak(false, '%.3f%s'); // 152B or 90.152Kb or 15.234Mb

// Returns the memory usage at the end mark
echo $bench->getMemoryUsage(); // 152B or 90.00Kb or 15.23Mb

// Accepts a callable as the first parameter.  Any additional parameters will be passed to the callable.
$result = $bench->run(function ($x) {
    return $x;
}, 1);
echo $bench->getTime();

Facade

If you don't want to use new keyword then use Facade.

use Asad\Bench\BFacade;

BFacade::start();
// Execute some code
BFacade::end();

echo BFacade::getTime();
echo BFacade::getMemoryPeak(true);

Testing

composer run test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

This Micro Framework developed by Devster. I'm the person who converted it to the Laravel package.

License

The MIT License (MIT). Please see License File for more information.