Download the PHP package jralph/retry without Composer
On this page you can find all versions of the php package jralph/retry. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package retry
PHP Retry
A simple library to retry commands in php.
Installation
This package is available through composer.
composer require jralph/retry
Basic Use
The library includes a simple helper function for ease of use.
Note: On a failure to succeed in running the command, a Jralph\Retry\RetryException
will be thrown.
Parameters
$attempts:
The number of times to attempt a command.- If a
callable
is provided, the retry will continue until this closure returns true.
- If a
$command:
The command to run each time.$onError:
An optional callback to run each time the$command
fails.
Example
Advanced Use / Object Use
If you want more flexibility over the retry tool, you can use the Retry
object directly and ignore the helper function.
The Retry
object is fully chainable to make things simple.
Available Methods
new Retry(Command $command);
The Command object to run as the command.$retry->attempts(int $attempts);
The maximum number of times to attempt the command. Note, an attempt count of 0 will run for ever!$retry->wait(int $seconds);
The number of seconds to wait between attempts.$retry->until(callable $until);
Retry until the result of$until
returns true. Note: Works well with$retry->attempts(0);
- Accepts
$attempt
as the first parameter, giving the current number of attempts. - Accepts
$response
as the second parameter, giving the response of the last attempt.
- Accepts
$retry->onlyIf(callable $onlyIf);
Retry only if the$onlyIf
returns true.- Accepts
$attempt
as the first parameter, giving the current number of attempts. - Accepts
$response
as the second parameter, giving the response of the last attempt.
- Accepts
$retry->onError(callable $onError);
A callback to run each time the retry fails.- Accepts
$attempt
as the first parameter, giving the current number of attempts. - Accepts
$response
as the second parameter, giving the response of the last attempt.
- Accepts
$retry->run();
Run the command using the specified setup.
Change Log
3.0.0
- Updated to php 8.0+.
2.0.0
- Removing of deprecated methods.
- Removal of once, twice, thrice, forever methods in favour of using
attempts(int $attempts)
. - Constructor only accepts
Command
objects.
1.2.0
- Updated to php 7.1+.
- Deprecated
command
method in favour of passing a command object into the constructor.
1.1.1
- Changed all methods using
\Closure
to usecallable
instead.
- Changed all methods using
1.1.0
- Added
wait(int $seconds);
method.
- Added
All versions of retry with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.0
The package jralph/retry contains the following files
Loading the files please wait ....