Download the PHP package green-elephpant/code-bench without Composer
On this page you can find all versions of the php package green-elephpant/code-bench. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package code-bench
Green ElePHPant - CodeBench
The Green ElePHPant wants to help you to reduce the carbon emissions of your software.
One way of doing so is to optimize the performance. Less CPU, RAM and Storage means reduced energy consumption, fewer carbon emissions, and less hardware to be produced. And, last but not least, the users of your software will benefit from a faster application.
GreenElephpant\CodeBench is a simple benchmark tool that can help you to improve the performance of your code by
benchmarking several possible solutions and helps you to decide which code to chose.
Key concept
GreenElephpant\CodeBench simply measures the execution time and memory consumption of callables, which contain
the code you want to measure.
Shout-out to PhpBench, which is a much better solution if you need super
accurate measurement, because it runs the code to be measured in isolation. It also is meant to be used as test suite
similar to PHPUnit and can thus be used to catch performance regressions during CI/CD, which makes it extremely useful .
However, GreenElephpant\CodeBench is your coding compadre if a quick and rough measurement is enough to decide
between several options.
Installation
Simply use composer to add GreenElephpant\CodeBench to your project:
composer require green-elephpant/code-bench --dev
Note: we use require-dev here, since GreenElephpant\CodeBench should not be used in production code.
Note: GreenElephpant\CodeBench works with PHP 7.2+ to support most code bases. However, only since PHP 8.2 the
functionmemory_reset_peak_usage is available. With
earlier verions, you will not be able to monitor the peak memory usage with this tool.
Configuration
GreenElephpant\CodeBench is designed to require no other dependencies to keep its footprint small, so there is
nothing more to do - just use it when needed. All possible options are passed with the function call.
Usage
Basic Usage
In its purest form, the usage is as easy as the following function call:
The result should be something similar to this:
What does the output mean?
Time (seconds)tells us the time in seconds that the callable needed to execute. Since the example is just a simple function call, it's just a fraction of a second.Memory (MB)is the difference of the used memory before and after the callable was executedMemory Peak (MB)is the biggest amount of memory (aka the peak) the callable required during its execution. Since PHP frees memory during the execution time, this measurement is much more important if you want to find out if the callable can hit the configured PHP memory limit.
Iterations
Results can vary between several executions of the callable. To balance out any outliers, we can run several iterations
and take the average. This behaviour is controlled by the $iterations parameter. The following example will run the
each callable 100 times:
Pre-run callable
By default, GreenElephpant\CodeBench executes the callable one time before starting with the actual measurement. This
is to avoid side effects by e.g. cache warmups. To disable this behaviour, run the benchmark with $preRunCallable set
to false:
Todos
- Adjust time display if smaller than a second
- show use() example
- implement loop parameter
