leaseweb / guzzle-bundle
Guzzle API call functionality with full Web Debug Toolbar integration
Installs: 44 069
Dependents: 0
Suggesters: 0
Security: 0
Stars: 27
Watchers: 14
Forks: 7
Open Issues: 4
Type:symfony-bundle
Requires
- php: >=5.3.2
- guzzle/guzzle: *
- symfony/framework-bundle: >=2.1
This package is not auto-updated.
Last update: 2020-11-13 20:08:56 UTC
README
This repository is no longer being actively maintained. We encourage you to not use this code. If you rely on this code you might want to fork the repository to keep your systems from breaking, if we remove this repository in the future.
LswGuzzleBundle
The LswGuzzleBundle adds Guzzle API call functionality to your Symfony2 application. It is easy to use from the code and is aimed to have full debugging capabilities.
Read the LeaseWebLabs blog about LswGuzzleBundle
Requirements
- PHP 5.3 with cURL support
- Symfony 2.3
Installation
Installation is broken down in the following steps:
- Download LswGuzzleBundle using composer
- Enable the Bundle
- Make sure the cURL module in PHP is enabled
Step 1: Download LswGuzzleBundle using composer
Add LswGuzzleBundle in your composer.json:
{ "require": { "leaseweb/guzzle-bundle": "*", ... } }
Now tell composer to download the bundle by running the command:
$ php composer.phar update leaseweb/guzzle-bundle
Composer will install the bundle to your project's vendor/leaseweb
directory.
Step 2: Enable the bundle
Enable the bundle in the kernel:
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Lsw\GuzzleBundle\LswGuzzleBundle(), ); }
Step 3: Make sure the cURL module in PHP is enabled
On a Debian based distribution (like Ubuntu) the package is called "php5-curl" and can be installed using the following commands:
$ sudo apt-get install php5-curl $ sudo service apache2 restart
On a RedHat based distribution (like CentOS) the package is called "php-curl" and can be installed using the following commands:
$ sudo yum install php-curl $ sudo service httpd restart
To check this create and run a PHP file with the following contents:
<?php phpinfo() ?>
It should display that the option "cURL support" is set to "enabled".
This package should work on a Windows installation as well provided the CURL support is enabled in PHP.
Configuration
These is an example of Guzzle client based on a service description (including cURL options):
lsw_guzzle:
clients:
test:
config:
json_objects: true
curl.options:
CURLOPT_CONNECTTIMEOUT: 10
CURLOPT_SSL_VERIFYPEER: false
CURLOPT_USERAGENT: "LeaseWeb API Caller"
CURLOPT_FOLLOWLOCATION: true
CURLOPT_SSLVERSION: 3
description:
baseUrl: "http://sf2testproject.dev"
operations:
test:
httpMethod: "GET"
uri: "/app_dev.php/demo/?a=b"
json:
httpMethod: "GET"
uri: "/app_dev.php/demo/json"
json_post:
httpMethod: "POST"
uri: "/app_dev.php/demo/{action}"
parameters:
testvalue:
location: xml
action:
location: uri
Usage
This is how to consume the described service commands:
$response = $this->get('guzzle.test')->getCommand('test')->execute();
$response = $this->get('guzzle.test')->getCommand('json')->execute();
$response = $this->get('guzzle.test')->getCommand('json_post',array('action'=>'json','testvalue'=>666))->execute();
License
This bundle is under the MIT license.