Download the PHP package getjoystick/joystick-php without Composer
On this page you can find all versions of the php package getjoystick/joystick-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download getjoystick/joystick-php
More information about getjoystick/joystick-php
Files in getjoystick/joystick-php
Package joystick-php
Short Description Joystick is a modern remote configuration and dynamic content service designed specifically for operating apps and games. Upgrade to more agility and evolve your product faster. Change or hot-update your content and configurations instantly at scale without code. Segment, ab test, feature flag, schedule events and more. Joystick is a breeze to use yet powerful.
License MIT
Homepage https://github.com/getjoystick/joystick-php
Informations about the package joystick-php
PHP client for Joystick
This is the library that simplifies the way how you can communicate with Joystick API.
Requirements
PHP 7.2 and later
Installation
You can install the package via Composer:
We will try to find the PSR-18 compatible HTTP client within your dependencies using
php-http/discovery
, if you don't have one
installed, just run this command to install
Guzzle HTTP client:
Usage
To use the client, use Composer's autoload:
Simple usage looks like this:
Requesting Content by single Content Id
Specifying additional parameters:
When creating the ClientConfig
object, you can specify additional parameters which will be used
by all API calls from the client, for more details see
API documentation:
Options
fullResponse
In most of the cases you will be not interested in the full response from the API, but if you're you can specify
fullResponse
option to the client methods. The client will return you raw API response:
serialized
When true
, we will pass query parameter responseType=serialized
to Joystick API.
refresh
If you want to ignore existing cache and request the new config – pass this option as true
.
This option can be set for every API call from the client by setting setSerialized(true)
:
Caching
By default, the client uses array caching, which means that if you build the HTTP application where each process exits after the request has been processed – the cache will be erased after the process is finished.
You can specify your cache implementation which conforms PSR-16.
See examples/file-cache
for more details.
Clear the cache
If you want to clear the cache – run $client->clearCache()
.
Note that we will call
clear()
on the PSR-16 interface. Make sure that you use different cache instances in different places of your app
HTTP Client
If you want to provide custom HTTP client, which may be useful for use-cases like specifying custom proxy, collecting detailed metrics about HTTP requests,
You can specify your HTTP client implementation which conforms PSR-18.
See examples/custom-http-client
for more details.
Testing
To run unit tests, just run:
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Joystick
- All Contributors
License
The MIT. Please see License File for more information.
All versions of joystick-php with dependencies
ext-curl Version *
ext-json Version *
beberlei/assert Version ^3.3
cache/array-adapter Version ^1.1
php-http/discovery Version ^1.15
psr/http-client Version ^1.0
psr/http-message Version ^1.0
psr/simple-cache Version ^1.0|^2.0|^3.0