Header plugin

Author: gsouf

plugins/header.rst

@@ -0,0 +1,30 @@
+Header Plugin
+=============
+
+The header plugin allows to set or remove headers from the request::
+
+    use Http\Discovery\HttpClientDiscovery;
+    use Http\Plugins\PluginClient;
+    use Http\Plugins\HeaderPlugin;
+
+    $headerPlugin = new HeaderPlugin($authentication);
+
+    // Set the header 'Content-Type' to the value 'application/json'
+    // Only if the request does not already defines a 'Content-Type' header
+    $headerPlugin->withHeader('Content-Type', 'application/json');
+
+    // Note the third param to true:
+    // We want every request to have the following 'User-Agent' header
+    // If the request already defines a 'User-Agent' header it will be replaced with this one
+    $headerPlugin->withHeader('User-Agent', 'Mozilla/5.0 (X11; Linux x86_64; rv:12.0)', true);
+
+
+    // We dont want the request to have 'Cookie' header
+    $headerPlugin->withoutHeader('Cookie');
+
+
+    $pluginClient = new PluginClient(
+        HttpClientDiscovery::find(),
+        [$headerPlugin]
+    );
+