UPGRADE.md

Upgrade instruction

This document describes the changes needed when upgrading from one version to another.

Upgrading From 7.x to 8.0

Step 1: upgrade PHP and Symfony

Minimum required PHP version was raised to 7.1 and Symfony to 4.0.
Rector can help you with migration.

Step 2: remove usage of GuzzleEventListenerInterface

The interface GuzzleEventListenerInterface was removed. Please read the documentation in case you want to listen pre/post translation events for specific client.

Step 3: follow strict typing rules

If your classes are overriding some classes from bundle, then check that all methods are following arguments and return types.

Step 4: replace usage of EightPointsGuzzleBundlePlugin interface

before:

use EightPoints\Bundle\GuzzleBundle\EightPointsGuzzleBundlePlugin;

class Foo implements EightPointsGuzzleBundlePlugin
{

}

after:

use EightPoints\Bundle\GuzzleBundle\PluginInterface;

class Foo implements PluginInterface
{

}

Upgrading From 6.x to 7.0

Step 1: change namespace in AppKernel

before:

public function registerBundles()
{
    $bundles = [
        ...
        new EightPoints\Bundle\GuzzleBundle\GuzzleBundle(),
        ...
    ];
}

after:

public function registerBundles()
{
    $bundles = [
        ...
        new EightPoints\Bundle\GuzzleBundle\EightPointsGuzzleBundle(),
        ...
    ];
}

Step 2: change config key in app/config/config.yml

before:

guzzle:
    clients:
        api_payment:
            base_url: "http://api.domain.tld"

after:

eight_points_guzzle:
    clients:
        api_payment:
            base_url: "http://api.domain.tld"

Step 3: move headers key under options config

before:

guzzle:
    clients:
        api_payment:
            base_url: "http://api.domain.tld"
            headers:
                Accept: "application/json"

after:

eight_points_guzzle:
    clients:
        api_payment:
            base_url: "http://api.domain.tld"
            options:
                headers:
                    Accept: "application/json"

Step 4: client call

before:

$this->get('guzzle.client.api_crm');

after:

$this->get('eight_points_guzzle.client.api_crm');

Step 5: event listeners definition

before:

<service id="listenerID" class="Your\ListenerClass\That\Implements\GuzzleEventListenerInterface">  
    <tag name="kernel.event_listener" event="guzzle_bundle.pre_transaction" method="onPreTransaction" service="servicename"/>  
</service>  

after:

<service id="listenerID" class="Your\ListenerClass\That\Implements\GuzzleEventListenerInterface">  
    <tag name="kernel.event_listener" event="eight_points_guzzle.pre_transaction" method="onPreTransaction" service="servicename"/>  
</service>  

Step 6: if you have created any services, you should change name

before:

<argument type="service" id="guzzle.client.xyz" />

after:

<argument type="service" id="eight_points_guzzle.client.xyz" />

Step 7: WSSE plugin

WSSE plugin was moved to separate repository. If you are using WSSE then follow install guide from gregurco/guzzle-bundle-wsse-plugin.