Download the PHP package kylewlawrence/gridpane-api-client-php without Composer
On this page you can find all versions of the php package kylewlawrence/gridpane-api-client-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kylewlawrence/gridpane-api-client-php
More information about kylewlawrence/gridpane-api-client-php
Files in kylewlawrence/gridpane-api-client-php
Package gridpane-api-client-php
Short Description GridPane API PHP SDK
License MIT
Homepage http://designanddevelop.io
Informations about the package gridpane-api-client-php
GridPane API PHP SDK Client Library
API Client Version
This is the first version of a community sponsored PHP SDK client for GridPane API.
API version support
This client only supports GridPane's API v1. Please see their API documentation for more information.
Requirements
- PHP 8.1+
Installation
The GridPane API PHP SDK client can be installed using Composer.
Are you using this with Laravel? If so, use the Laravel wrapper.
Composer
To install run composer require kylewlawrence/gridpane-api-client-php
Configuration
Configuration is done through an instance of GridPane\Api\HttpClient
.
The block is mandatory and if not passed, an error will be thrown.
Usage
Basic Operations
Discovering Methods & Classes
Pagination
The GridPane API offers a way to get the next pages for the requests and is documented in the GridPane Developer Documentation.
The way to do this is to pass it as an option to your request.
The allowed options are
- per_page
- page
Retrying Requests
Add the RetryHandler
middleware on the HandlerStack
of your GuzzleHttp\Client
instance. By default GridPane\Api\HttpClient
retries:
- timeout requests
- those that throw
Psr\Http\Message\RequestInterface\ConnectException:class
- and those that throw
Psr\Http\Message\RequestInterface\RequestException:class
that are identified as ssl issue.
Available options
Options are passed on RetryHandler
as an array of values.
- max = 2 limit of retries
- interval = 300 base delay between retries in milliseconds
- max_interval = 20000 maximum delay value
- backoff_factor = 1 backoff factor
- exceptions = [ConnectException::class] _Exceptions to retry without checking retryif
- retry_if = null callable function that can decide whether to retry the request or not
Contributing
Pull Requests are always welcome. I'll catch-up and develop the contribution guidelines soon. For the meantime, just open and issue or create a pull request.
Copyright and license
Copyright 2013-present GridPane
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
All versions of gridpane-api-client-php with dependencies
guzzlehttp/psr7 Version ^2.0
php Version >=8.1
doctrine/inflector Version ^2.0