jrosset
/
phpexecutiontimer
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial commit

Browse Source
master
Julien Rosset 4 years ago
commit d12f197345
9 changed files with 629 additions and 0 deletions
Show Stats Download Patch File Download Diff File

2
.gitignore vendored
Unescape Escape View File

@ -0,0 +1,2 @@
.idea/
vendor/

96
LICENSE.md
Unescape Escape View File

@ -0,0 +1,96 @@
# [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
## Creative Commons Attribution 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
### Section 1 – Definitions.
Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
Licensor means the individual(s) or entity(ies) granting rights under this Public License.
Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
### Section 2 – Scope.
License grant.
Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
reproduce and Share the Licensed Material, in whole or in part; and
produce, reproduce, and Share Adapted Material.
Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
Term. The term of this Public License is specified in Section 6(a).
Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
Downstream recipients.
Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
Other rights.
Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
Patent and trademark rights are not licensed under this Public License.
To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
### Section 3 – License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
Attribution.
If You Share the Licensed Material (including in modified form), You must:
retain the following if it is supplied by the Licensor with the Licensed Material:
identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
a copyright notice;
a notice that refers to this Public License;
a notice that refers to the disclaimer of warranties;
a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
### Section 4 – Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
### Section 5 – Disclaimer of Warranties and Limitation of Liability.
Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
### Section 6 – Term and Termination.
This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
### Section 7 – Other Terms and Conditions.
The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
### Section 8 – Interpretation.
For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

60
README.md
Unescape Escape View File

@ -0,0 +1,60 @@
# PHPExecutionTimer
__Utility class for execution time measurement__
![last release](https://badgen.net/packagist/v/darkelfe14728/executiontimer?label=Last%20release)
![licence](https://badgen.net/packagist/license/darkelfe14728/executiontimer?color=red)
![nb releases](https://badgen.net/packagist/dt/darkelfe14728/executiontimer?color=green)
A utility class to measure and display execution time.
Include step time measurement.
## Installation
```
composer require darkelfe14728/executiontimer
```
[comment]: <> (## Description)
[comment]: <> (At first, create a new CommandLine with program name and description. Add options and values by using respectively _addOption_ and _addValue_.)
[comment]: <> (Default options for help &#40;-h / --help&#41; and version &#40;--version&#41; can be add with _addDefaultArguments_ and use _treatDefaultArguments_ for launching associated treatments.)
[comment]: <> (Treat script arguments with _parse_ : return an object of variables.)
[comment]: <> (## Example )
[comment]: <> (```php)
[comment]: <> (<?php)
[comment]: <> (use CommandLine\CommandLine;)
[comment]: <> (use CommandLine\Argument\Option\Flag;)
[comment]: <> (use CommandLine\Argument\Parser\StringParser;)
[comment]: <> (use CommandLine\Argument\Value\Value;)
[comment]: <> ($cmdline = new CommandLine&#40;'Checker', 'File checker', 'php checker.php'&#41;;)
[comment]: <> ($cmdline->addDefaultArguments&#40;&#41;;)
[comment]: <> ($cmdline->addOption&#40;new Flag&#40;'enhanced', false, 'Deep check ?'&#41;&#41;;)
[comment]: <> ($cmdline->addValue&#40;new Value&#40;'path', 'File path', new StringParser&#40;&#41;&#41;&#41;;)
[comment]: <> (var_dump&#40;$args = $cmdline->parse&#40;&#41;&#41;;)
[comment]: <> ($cmdline->treatDefaultArguments&#40;$args&#41;;)
[comment]: <> (```)
[comment]: <> (Would display something like that : )
[comment]: <> ( class stdClass#13 &#40;1&#41; {)
[comment]: <> ( public $enhanced => bool&#40;false&#41;)
[comment]: <> ( public $path => string&#40;"my/path/to/a/file"&#41;)
[comment]: <> ( })

25
Tests/test.php
Unescape Escape View File

@ -0,0 +1,25 @@
<?php
require_once __DIR__ . '/../vendor/autoload.php';
use jrosset\ExecutionTimer\ExecutionTimer;
$timer = new ExecutionTimer(false);
$timer->start();
sleep(3);
$timer->step('sleep 1');
var_dump($timer->getLastStepRelativeDuration()->toUserString(), (string)$timer->getLastStepDuration());
sleep(2);
$timer->step('sleep 2');
var_dump($timer->getLastStepRelativeDuration()->toUserString(), (string)$timer->getLastStepDuration());
$timer->stop();
var_dump($timer->getStepsDuration());
$final = $timer->getDuration();
var_dump($timer->getRelativeDuration()->toUserString(), (string)$final);
var_dump($final->getMilliseconds(), $final->getMilliseconds()->asAbsoluteFactional(), $final->getMilliseconds()->asRelativeFactional());

33
composer.json
Unescape Escape View File

@ -0,0 +1,33 @@
{
"name": "darkelfe14728/executiontimer",
"description": "Utility class for execution time measurement",
"keywords": [ "time" ],
"minimum-stability": "dev",
"require": {
"php": "^5.3 || ^7 || 8.0"
},
"autoload": {
"psr-4": {
"jrosset\\": "src/"
},
"exclude-from-classmap": [ "Tests/" ]
},
"readme": "README.md",
"homepage": "https://git.jrosset.ovh/darkelfe14728/PhpExecutionTimer",
"license": "CC-BY-4.0",
"authors": [
{
"name": "Julien Rosset",
"email": "jul.rosset@gmail.com"
}
],
"support": {
"email": "jul.rosset@gmail.com",
"issues": "https://git.jrosset.ovh/darkelfe14728/PhpExecutionTimer/issues",
"wiki": "https://git.jrosset.ovh/darkelfe14728/PhpExecutionTimer/wiki",
"docs": "https://git.jrosset.ovh/darkelfe14728/PhpExecutionTimer/wiki",
"source": "https://git.jrosset.ovh/darkelfe14728/PhpExecutionTimer"
}
}

20
composer.lock generated
Unescape Escape View File

@ -0,0 +1,20 @@
{
"_readme": [
"This file locks the dependencies of your project to a known state",
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "69d55a6bf0edcd4bb090526db2f1b47d",
"packages": [],
"packages-dev": [],
"aliases": [],
"minimum-stability": "dev",
"stability-flags": [],
"prefer-stable": false,
"prefer-lowest": false,
"platform": {
"php": "^5.3 || ^7 || 8.0"
},
"platform-dev": [],
"plugin-api-version": "1.1.0"
}

128
src/ExecutionTimer/Duration.php
Unescape Escape View File

@ -0,0 +1,128 @@
<?php
namespace jrosset\ExecutionTimer;
/**
* Store a time duration
*/
class Duration {
const EPSILON = 0.0000001;
/**
* @var float The time duration
*/
private $duration;
/**
* Duration constructor.
*
* @param float $duration Time duration, in seconds fraction
*/
public function __construct ($duration = 0) {
$this->duration = abs($duration);
}
/**
* Convert duration to string
*
* @return string The duration, as string
*/
public function __toString () {
return $this->getDays()->asRelativeWhole() . ' '
. $this->getHours()->asRelativeWhole() . ':'
. $this->getMinutes()->asRelativeWhole() . ':'
. $this->getSeconds()->asRelativeWhole() . '.'
. $this->getMilliseconds()->asRelativeWhole()
. $this->getMicroseconds()->asRelativeWhole();
}
/**
* Convert duration to user friendly string
*
* @return string The duration, as user friendly string
*/
public function toUserString () {
$parts = array(
$this->getDays()->asRelativeWhole() > 0 ? $this->getDays()->asRelativeWhole() . ' days' : '',
$this->getHours()->asRelativeWhole() > 0 ? $this->getHours()->asRelativeWhole() . ' hours' : '',
$this->getMinutes()->asRelativeWhole() > 0 ? $this->getMinutes()->asRelativeWhole() . ' minutes' : '',
$this->getSeconds()->asRelativeWhole() > 0 ? $this->getSeconds()->asRelativeWhole() . ' seconds' : '',
$this->getMilliseconds()->asRelativeWhole() > 0 ? $this->getMilliseconds()->asRelativeWhole() . ' milliseconds' : '',
);
$parts = array_filter(
$parts,
function ($part) {
return $part != '';
}
);
$last = array_pop($parts);
return (count($parts) > 0 ? implode(' ', $parts) . ' and ' : '') . $last;
}
/**
* The base time duration
*
* @return float The base time duration
*/
public function getDuration () {
return $this->duration;
}
/**
* Contains a time duration ? (more than 0 microseconds)
*
* @return bool True if contains a time duration
*/
public function hasTime () {
return abs($this->duration - 0) > self::EPSILON;
}
/**
* The time in microseconds
*
* @return DurationUnit The time in microseconds
*/
public function getMicroseconds () {
return new DurationUnit($this->duration * 1000000, DurationUnit::UNIT_MICROSECONDS); // 1000 milliseconds * 1000 microseconds
}
/**
* The time in milliseconds
*
* @return DurationUnit The time in milliseconds
*/
public function getMilliseconds () {
return new DurationUnit($this->duration * 1000, DurationUnit::UNIT_MILLISECONDS); // 1000 milliseconds
}
/**
* The time in seconds
*
* @return DurationUnit The time in seconds
*/
public function getSeconds () {
return new DurationUnit($this->duration, DurationUnit::UNIT_SECONDS);
}
/**
* The time in seconds
*
* @return DurationUnit The time in seconds
*/
public function getMinutes () {
return new DurationUnit($this->duration / 60, DurationUnit::UNIT_MINUTES); // 60 seconds
}
/**
* The time in hours
*
* @return DurationUnit The time in hours
*/
public function getHours () {
return new DurationUnit($this->duration / 3600, DurationUnit::UNIT_HOURS); // 60 seconds * 60 minutes
}
/**
* The time in days
*
* @return DurationUnit The time in days
*/
public function getDays() {
return new DurationUnit($this->duration / 86400, DurationUnit::UNIT_DAYS); // 60 seconds * 60 minutes * 24 hours
}
}

94
src/ExecutionTimer/DurationUnit.php
Unescape Escape View File

@ -0,0 +1,94 @@
<?php
namespace jrosset\ExecutionTimer;
/**
* A time duration in a unit
*/
class DurationUnit {
const UNIT_MICROSECONDS = -2;
const UNIT_MILLISECONDS = -1;
const UNIT_SECONDS = 0;
const UNIT_MINUTES = 1;
const UNIT_HOURS = 2;
const UNIT_DAYS = 3;
/**
* @var float Time duration, in the unit
*/
private $duration;
/**
* @var int The time unit : self::UNIT_*
*/
private $unit;
/**
* @var int The maximum value of time unit (e.g. maximum of 60 secondes). 0 if no maximum (UNIT_DAYS)
*/
private $unit_max;
/**
* New time duration
*
* @param float $time Time duration, in the unit
* @param int $unit The time unit : self::UNIT_*
*/
public function __construct ($time, $unit) {
$this->duration = $time;
$this->unit = $unit;
$units_max = array(
self::UNIT_MICROSECONDS => 1000,
self::UNIT_MILLISECONDS => 1000,
self::UNIT_SECONDS => 60,
self::UNIT_MINUTES => 60,
self::UNIT_HOURS => 24,
self::UNIT_DAYS => 0,
);
$this->unit_max = $units_max[$unit];
}
/**
* The maximum value of time unit
*
* E.g. maximum of 60 secondes<br>
* 0 if no maximum (UNIT_DAYS)
*
* @return int The maximum value of time unit
*/
public function getUnit () {
return $this->unit;
}
/**
* Get absolute time, with fractional
*
* @return float The absolute time, with fractional
*/
public function asAbsoluteFactional () {
return $this->duration;
}
/**
* Get absolute time, without fractional
*
* @return int The absolute time, without fractional
*/
public function asAbsoluteWhole () {
return (int)floor($this->asAbsoluteFactional());
}
/**
* Get relative time (to upper unit), with fractional
*
* @return float The relative time, with fractional
*/
public function asRelativeFactional () {
return $this->unit_max === 0 ? $this->asAbsoluteFactional() : $this->asAbsoluteFactional() % $this->unit_max;
}
/**
* Get relative time (to upper unit), without fractional
*
* @return int The relative time, without fractional
*/
public function asRelativeWhole () {
return $this->unit_max === 0 ? $this->asAbsoluteWhole() : $this->asAbsoluteWhole() % $this->unit_max;
}
}

171
src/ExecutionTimer/ExecutionTimer.php
Unescape Escape View File

@ -0,0 +1,171 @@
<?php
namespace jrosset\ExecutionTimer;
/**
* The time measurer
*
* The main class
*/
class ExecutionTimer {
/**
* @var float Initial start time, in fractional seconds
*/
private $timeStart;
/**
* @var float[] Stop time of steps, in fractional seconds
*/
private $timeSteps;
/**
* @var float Stop time, in fractional seconds
*/
private $timeStop;
/**
* New time measurer
*
* @param bool $autostart Start time measurement ?
*/
public function __construct ($autostart = true) {
$this->timeStart = 0;
$this->timeSteps = array();
$this->timeStop = 0;
if ($autostart) {
$this->start();
}
}
/**
* Measure current time as seconds with fractions
*
* @return float The current time
*/
private function measureTime () {
return microtime(true);
}
/**
* Start a new time measurement
*/
public function start () {
$this->timeStart = $this->measureTime();
$this->timeSteps = array();
$this->timeStop = 0;
}
/**
* Measure a new step
*
* @param string name The name of the step
*/
public function step ($name = '') {
$this->timeSteps[$name === '' ? count($this->timeSteps) + 1 : $name] = $this->measureTime();
}
/**
* Stop time measurement
*/
public function stop () {
$this->timeStop = $this->measureTime();
}
/**
* Is time measured ?
*
* @return bool True if time is measured
*/
public function isStart () {
return $this->timeStop === 0;
}
/**
* The number of steps measured
*
* @return int The number of steps measured
*/
public function nbSteps () {
return count($this->timeSteps);
}
/**
* Has at least one step measured ?
*
* @return bool True if a least on step measured
*/
public function hasSteps () {
return $this->nbSteps() > 0;
}
/**
* List of steps durations
*
* Each step provide an array of {@see Duration} with two cells :
* # The duration relative to previous step or initial start time if first step
* # The duration (relative to initial start time)
*
* @return Duration[][] List of steps durations
*/
public function getStepsDuration () {
$steps = array();
if (!$this->hasSteps()) {
return $steps;
}
$timePrevious = $this->timeStart;
foreach ($this->timeSteps as $stepName => $timeStep) {
$steps[$stepName] = array(new Duration($timeStep - $timePrevious), new Duration($timeStep - $this->timeStart));
$timePrevious = $timeStep;
}
return $steps;
}
/**
* The last step duration relative to previous step or initial start time if first step
*
* @return Duration The time duration
*/
public function getLastStepRelativeDuration () {
switch($this->nbSteps()) {
case 0:
return new Duration();
case 1:
return new Duration(reset($this->timeSteps) - $this->timeStart);
default:
$time = end($this->timeSteps);
return new Duration( $time- prev($this->timeSteps));
}
}
/**
* The last step duration (relative to initial start time)
*
* @return Duration The time duration
*/
public function getLastStepDuration () {
if($this->nbSteps() === 0) {
return new Duration();
}
return new Duration( end($this->timeSteps) - $this->timeStart);
}
/**
* The total duration relative to previous step or initial start time if first step
*
* @return Duration The time duration
*/
public function getRelativeDuration () {
if($this->nbSteps() === 0) {
return $this->getDuration();
}
return new Duration( $this->timeStop - end($this->timeSteps));
}
/**
* The total duration (relative to initial start time)
*
* @return Duration The time duration
*/
public function getDuration () {
return new Duration($this->timeStop - $this->timeStart);
}
}
Write Preview
Loading…
Cancel
Save