Download the PHP package pensiero/artax-composer without Composer
On this page you can find all versions of the php package pensiero/artax-composer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pensiero/artax-composer
More information about pensiero/artax-composer
Files in pensiero/artax-composer
Package artax-composer
Short Description Wrapper of the Artax library
License BSD-3-Clause
Homepage https://github.com/pensiero/artax-composer
Informations about the package artax-composer
artax-composer
ArtaxComposer is a Zend Framework 2 service wrapper around the amphp/artax client
Getting Started
Add ArtaxComposer
as module in your application.config.php
Usage
You will now have access to the ArtaxComposer\Service\ArtaxService
service.
You can get it in your factory:
Configs
By default ArtaxComposer come with this configs
You can ovveride them in your module.config.php
Available methods
Each methods is chainable, except for the get()
, post()
, put()
and delete()
methods.
setUri(string $uri)
Set the URI of the request.
setParams(array $params)
Set the params passed to the request. GET params should not be passed in the uri, but via this method.
addHeader(string $name, string $value)
Add an header.
setHeaders(array $headers)
Replace all headers via those passed.
withHeaders()
Return headers along the response.
setAuthToken(string $authToken)
Set an header authorization token in the form key: Authorization
, value: Token token="AUTH_TOKEN"
.
useCache(int $ttl = null)
Cache each request via the cache defined in module.config.php
(example below).
reset()
Reset all params passed before. Default headers will be restored if previously overwritten.
debug()
Instead of the response, return an array of all the configuration passed to the service.
returnObject()
The response will be an object.
returnArray()
The response will be an array.
returnObject()
The response will be a json string.
get()
Perform a GET request and return
a response.
post()
Perform a POST request and return
a response.
put()
Perform a PUT request and return
a response.
delete()
Perform a DELETE request and return
a response.
Examples
Simple GET request with params
POST request with params and cache
In your module.config.php
Create module/src/Application/Cache/RedisFactory.php
Call:
All versions of artax-composer with dependencies
amphp/artax Version 2.*
zendframework/zend-cache Version ~2.7
zendframework/zend-modulemanager Version ~2.7
zendframework/zend-mvc Version ~2.7
php-http/guzzle6-adapter Version 1.*