Download the PHP package bbc/ipr-webservicekit without Composer
On this page you can find all versions of the php package bbc/ipr-webservicekit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package ipr-webservicekit
BBC\iPlayerRadio\WebserviceKit
A powerful layer for reading data from webservices in a fast, extendable and resilient way.
- Requirements
- Features
- Background
- Basic Usage
- Documentation
Requirements
- PHP >= 5.6
Features
- Resilient, stale-while-revalidate caching at the core
- Full monitoring and logging hooks
- Lightweight (usually a single class) integration of webservices
- Variable cURL timeouts based on cache state
- Multi-curl requests
- Circuit breaker protection for backends
- Framework agnostic
- Highly tested and battle-proven
- Unit testing helper traits to simplify mocking webservices
Background
This library makes it easy to read data from RESTful or HTTP based APIs, be they public, API key gated or via SSL certificates.
To integrate a new backend, the library consumer simply needs to create a class that implements
BBC\iPlayerRadio\WebserviceKit\QueryInterface
(you can even just subclass the BBC\iPlayerRadio\WebserviceKit\Query
class
that covers most of the essentials!)
These queries tell WebserviceKit how to communicate with the backend service, how to cache it and what to do with the responses it receives.
Basic Usage
You will only need a single instance of WebserviceKit within your app, which you then pass Query's into.
You can then define Query classes:
Fetching this queries is then as simple as:
You can also run multiple queries at the same time:
This is the most basic usage of WebserviceKit, there's a lot more power beneath the hood should you need it.
Documentation
Full documentation can be found in the docs/ folder of the repo!
All versions of ipr-webservicekit with dependencies
doctrine/cache Version ^1.0
guzzlehttp/guzzle Version ^6.1
solution10/circuitbreaker Version ^1.1
bbc/ipr-cache Version ^1.0