Download the PHP package morjodrom/time-limiter without Composer
On this page you can find all versions of the php package morjodrom/time-limiter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download morjodrom/time-limiter
More information about morjodrom/time-limiter
Files in morjodrom/time-limiter
Package time-limiter
Short Description A class helping to track time left to perform a php script
License MIT
Homepage https://github.com/Morjodrom/time-limiter
Informations about the package time-limiter
Time Limiter
A small utility class to help to limit script execution time.
Basic usage
The class is usually used within loops with heavy time consumption.
Installation
As a production dependency using Composer:
composer require morjodrom/time-limiter
As a dev-dependency for deveopment-only cases:
composer require --dev morjodrom/time-limiter
Constructor options
int $limitSeconds
- seconds to process. 0 equals to no limit.
Value from ini_get('max_execution_time')
might be the desired option.
[int $preliminaryTimeout] = DEFAULT_TIME_UP_SECONDS = 3
seconds to stop execution preliminary
before reaching the timeout.
$preliminaryTimeout
must be a bit greater that the longest theoretical operation you perform in a loop.
Therefore, the last risky operation that might exceed the execution time is omitted.
The class tracks the time spend on each iteration to update $preliminaryTimeout to equal the longest operation
[int|null $startTimestamp = $_SERVER['REQUEST_TIME']
is used by default. Must be a timestamp since Unix Epoch (January 1 1970 00:00:00 GMT), e.g.time()
call.
It is highly encouraged to use foreach
construction. Raw while
iteration also is
possible with correct Iterator calls
Methods
current(): int
- returns number of seconds left before the timeout
valid(): bool
- returns if there is time left to perform the script safely
next(): void
- must be called after a finished iteration to adapt to unexpected long iterations
Support
Feel free to open an issue: https://github.com/Morjodrom/time-limiter/issues