Download the PHP package jdz/process without Composer
On this page you can find all versions of the php package jdz/process. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package process
Process
A PHP package for tracking the execution time of processes, sections, and subsections. This package allows you to track and format the time taken for each part of your process, providing a detailed hierarchical view of the execution time.
Features
- Track execution time of processes, sections, and subsections
- Hierarchical structure for sections and subsections
- Formatted time output
- Easy to use API
Upgrading from 1.x: the 1.0.0 entry point was
Process::singleton(). Since 2.0.0 it isProcess::create();singleton()is deprecated but still there (it delegates tocreate()).
Requirements
- PHP 8.2 or higher
Installation
Install via Composer:
Quick Start
Basic Example
Here is a basic example of how to use the Process class to track the execution time of a process, including sections and subsections. You can find the complete example in the file examples/example.php.
Example Output
When calling toArray(), it will return an array of lines representing the process, sections, and subsections (one entry per line, timings vary):
Methods Overview
Process::create(): Get the sharedProcessinstance (created on first call).Process::singleton()is a deprecated alias.startSection(string $name): Start a new section with the given name.startSubsection(string $name, bool $endPrevious = true): Start a new subsection within the current section.endSection(): End the current section and close all its subsections.endSubsection(): End the current subsection and return to the parent section.close(): End the process and calculate the total execution time.getTime(): Get the formatted time for the entire process.toArray(): Export the sections and their execution times as an array of formatted strings.
Time Format
The time is formatted as follows:
- Minutes: Only shown if greater than 0.
- Seconds: Only shown if greater than 0 or if minutes are shown.
- Milliseconds: Always shown if non-zero, or if minutes or seconds are shown.
Examples of formatted time:
3 min 3 s 234 ms2 s 150 ms0ms(zero duration)
Testing
Run the test suite:
-
ProcessItemTest covers the ProcessItem class, including:
- Construction and initialization
- Parent-child relationships
- Time tracking and closure
- Hierarchical export functionality
- Time formatting
- ProcessTest covers the Process class, including:
- Shared instance (
create()/ deprecatedsingleton()) - Section and subsection management
- Time tracking and formatting
- Complex nested workflows
- Idempotent operations
- Shared instance (
License
This library is licensed under the MIT License. See the LICENSE file for details.
Changelog
Version 2.0.2
- Times are rounded to the millisecond before being split: 0.9996 s reads
1 s 0 ms, not1000 ms - An item that is not closed yet formats as
0mswithout a PHP deprecation ProcessItem::formatSeconds(): the one formatter, shared byProcessandProcessItem
Version 2.0.1
- Requires PHP >= 8.2
- PHPUnit 11
Version 2.0.0
- Added
create();singleton()is deprecated in its favor (still available, delegates tocreate()). - Added Unit tests
- Improved time formatting to handle zero durations correctly.
Version 1.0
- Initial release with core functionality for tracking process execution time, sections, and subsections.