From dc30007818db41e37c587225e74ae87bf3e1bf1b Mon Sep 17 00:00:00 2001 From: kristuff Date: Wed, 8 Dec 2021 20:42:33 +0100 Subject: [PATCH] v0.9.15 **Changes** - **New** `ApiHandler::setTimeout(int $timeout)` method allows to change default timeout before any API request. Timeout is expressed in milliseconds. Overwrites the value passed in constructor, useful when performing multiple queries with same handler but different timeout. --- README.md | 5 +++-- lib/ApiBase.php | 2 +- lib/ApiHandler.php | 19 +++++++++++++++++-- lib/ApiResponse.php | 2 +- lib/CurlTrait.php | 2 +- lib/InvalidPermissionException.php | 2 +- lib/QuietApiHandler.php | 2 +- 7 files changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 451e100..411be3d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ Features - Single IP report request **✓** - Bulk report request (send `csv` file) **✓** - Clear IP address request (remove your own reports) **✓** -- Auto cleaning report comments from sensitive data (email, custom ip/domain names list) **✓** +- Auto cleaning report comments from sensitive data (email, custom ip/domain names list) **✓** +- Define timeout for cURL internal requests **✓** Requirements ------------ @@ -32,7 +33,7 @@ Deploy with composer: ```json ... "require": { - "kristuff/abuseipdb": "^0.9.14-stable" + "kristuff/abuseipdb": "^0.9.15-stable" }, ``` diff --git a/lib/ApiBase.php b/lib/ApiBase.php index 238237a..78c83eb 100644 --- a/lib/ApiBase.php +++ b/lib/ApiBase.php @@ -13,7 +13,7 @@ * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. * - * @version 0.9.14 + * @version 0.9.15 * @copyright 2020-2021 Kristuff */ diff --git a/lib/ApiHandler.php b/lib/ApiHandler.php index b878010..a6326c2 100644 --- a/lib/ApiHandler.php +++ b/lib/ApiHandler.php @@ -13,7 +13,7 @@ * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. * - * @version 0.9.14 + * @version 0.9.15 * @copyright 2020-2021 Kristuff */ @@ -34,7 +34,7 @@ class ApiHandler extends ApiBase /** * @var string */ - const VERSION = 'v0.9.14'; + const VERSION = 'v0.9.15'; /** * The ips to remove from report messages @@ -72,6 +72,21 @@ class ApiHandler extends ApiBase $this->timeout = $timeout; } + /** + * Sets the cURL timeout (apply then to any API request). Overwrites the value passed in + * constructor, useful when performing multiple queries with same handler but different timeout. + * + * @access public + * @param int $timeout The maximum number of milliseconds to allow internal cURL functions + * to execute. + * + * @return void + */ + public function setTimeout(int $timeout): void + { + $this->timeout = $timeout; + } + /** * Get the current configuration in a indexed array * diff --git a/lib/ApiResponse.php b/lib/ApiResponse.php index d4abd1b..8b184f0 100644 --- a/lib/ApiResponse.php +++ b/lib/ApiResponse.php @@ -13,7 +13,7 @@ * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. * - * @version 0.9.14 + * @version 0.9.15 * @copyright 2020-2021 Kristuff */ diff --git a/lib/CurlTrait.php b/lib/CurlTrait.php index cbacf0f..abce7bd 100644 --- a/lib/CurlTrait.php +++ b/lib/CurlTrait.php @@ -13,7 +13,7 @@ * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. * - * @version 0.9.14 + * @version 0.9.15 * @copyright 2020-2021 Kristuff */ diff --git a/lib/InvalidPermissionException.php b/lib/InvalidPermissionException.php index 14e34aa..f0b6acb 100644 --- a/lib/InvalidPermissionException.php +++ b/lib/InvalidPermissionException.php @@ -13,7 +13,7 @@ * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. * - * @version 0.9.14 + * @version 0.9.15 * @copyright 2020-2021 Kristuff */ diff --git a/lib/QuietApiHandler.php b/lib/QuietApiHandler.php index 2c69d81..650df31 100644 --- a/lib/QuietApiHandler.php +++ b/lib/QuietApiHandler.php @@ -13,7 +13,7 @@ * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. * - * @version 0.9.14 + * @version 0.9.15 * @copyright 2020-2021 Kristuff */