https://github.com/bnomei/kirby3-stopwatch
Profile your Kirby CMS code with precision in milliseconds (or seconds)
https://github.com/bnomei/kirby3-stopwatch
kirby-cms kirby-plugin measure milliseconds profile stopwatch usleep
Last synced: 6 months ago
JSON representation
Profile your Kirby CMS code with precision in milliseconds (or seconds)
- Host: GitHub
- URL: https://github.com/bnomei/kirby3-stopwatch
- Owner: bnomei
- License: mit
- Archived: true
- Created: 2019-08-18T10:11:16.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-23T16:58:33.000Z (11 months ago)
- Last Synced: 2025-02-18T05:44:44.677Z (8 months ago)
- Topics: kirby-cms, kirby-plugin, measure, milliseconds, profile, stopwatch, usleep
- Language: PHP
- Homepage:
- Size: 142 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Kirby Stopwatch
[](https://travis-ci.com/bnomei/kirby3-stopwatch)
[](https://coveralls.io/github/bnomei/kirby3-stopwatch)
[](https://codeclimate.com/github/bnomei/kirby3-stopwatch)
[](https://twitter.com/bnomei)
Profile your Kirby CMS code with precision in milliseconds (or seconds).
## Installation
- unzip [master.zip](https://github.com/bnomei/kirby3-stopwatch/archive/master.zip) as folder `site/plugins/kirby3-stopwatch` or
- `git submodule add https://github.com/bnomei/kirby3-stopwatch.git site/plugins/kirby3-stopwatch` or
- `composer require bnomei/kirby3-stopwatch`
## Works well with
- [Janitor Plugin](https://github.com/bnomei/kirby3-janitor)
- [Monolog Plugin](https://github.com/bnomei/kirby3-monolog)
## Usage Site Method
Please read the [Symfony Stopwatch Component Docs](https://symfony.com/doc/current/components/stopwatch.html) since this plugin is just a soft wrapper around it. Some Examples:
**Event Duration**
```php
site()->stopwatch()->start('myevent');
sleep(1);
site()->stopwatch()->stop('myevent');
echo site()->stopwatch()->duration('myevent') . PHP_EOL; // float | int
```
**Event with Laps aka Periods**
```php
$eventName = 'my event with laps';
$stopwatch = site()->stopwatch();
$stopwatch->start($eventName);
foreach ([random_int(100,500),random_int(100,500),random_int(100,500)] as $time) {
usleep($time);
$stopwatch->lap($eventName);
}
usleep(100);
$stopwatch->stop($eventName);
$totalDuration = $stopwatch->duration($eventName); // float | int
echo $totalDuration . PHP_EOL;
foreach ($stopwatch->getEvent($eventName)->getPeriods() as $period) {
echo $period->getDuration() . PHP_EOL; // float | int
}
```
## Usage PHP Class
You can use the provided php class in your own classes if you make sure the class is loaded before you call it. This can be done in installing this plugin using composer or in manually requiring it with [Kirby's class loader](https://getkirby.com/docs/reference/templates/helpers/load).
```php
$stopwatch = \Bnomei\Stopwatch::singleton();
$stopwatch->start('my event with laps');
sleep(1);
$stopwatch->stop('my event with laps');
$duration = $stopwatch->duration('my event with laps'); // float | int
```
## Settings
| bnomei.stopwatch. | Default | Description |
|---------------------------|----------------|---------------------------|
| precision | `true` | measure microseconds as float or int seconds. |
> NOTE: This plugin defaults to measuring in milliseconds but the symfony component does not.
## Dependencies
- [symfony/stopwatch](https://github.com/symfony/stopwatch)
## Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-stopwatch/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.