readme & changelog

CHANGELOG.md

@@ -50,3 +50,6 @@
 
 # 1.8.0
 - Fix for unauthorized access when extracting the Opencast API Version.
+
+# 1.9.0
+- Allow passing additonal options to Guzzle #30

README.md

@@ -25,8 +25,9 @@ $config = [
       'timeout' => 0,                                 // The API timeout. In seconds (default 0 to wait indefinitely). (optional)
       'connect_timeout' => 0,                         // The API connection timeout. In seconds (default 0 to wait indefinitely) (optional)
       'version' => null,                              // The API Version. (Default null). (optional)
-      'handler' => null                               // The callable Handler or HandlerStack. (Default null). (optional)
-      'features' => null                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'handler' => null,                               // The callable Handler or HandlerStack. (Default null). (optional)
+      'features' => null,                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'guzzle' => null,                                // Additional Guzzle Request Options. These options can overwrite some default options (Default null). (optional)
 ];
 
 $engageConfig = [
@@ -36,8 +37,9 @@ $engageConfig = [
       'timeout' => 0,                                 // The API timeout. In seconds (default 0 to wait indefinitely). (optional)
       'connect_timeout' => 0,                         // The API connection timeout. In seconds (default 0 to wait indefinitely) (optional)
       'version' => null,                              // The API version. (Default null). (optional)
-      'handler' => null                               // The callable Handler or HandlerStack. (Default null). (optional)
-      'features' => null                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'handler' => null,                               // The callable Handler or HandlerStack. (Default null). (optional)
+      'features' => null,                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'guzzle' => null,                                // Additional Guzzle Request Options. These options can overwrite some default options (Default null). (optional)
 ];
 
 use OpencastApi\Opencast;
@@ -74,8 +76,9 @@ $config = [
       'timeout' => 0,                                 // The API timeout. In seconds (default 0 to wait indefinitely). (optional)
       'connect_timeout' => 0,                         // The API connection timeout. In seconds (default 0 to wait indefinitely) (optional)
       'version' => null,                              // The API version. (Default null). (optional)
-      'handler' => null                               // The callable Handler or HandlerStack. (Default null). (optional)
-      'features' => null                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'handler' => null,                               // The callable Handler or HandlerStack. (Default null). (optional)
+      'features' => null,                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'guzzle' => null,                                // Additional Guzzle Request Options. These options can overwrite some default options (Default null). (optional)
 ];
 
 
@@ -114,10 +117,12 @@ $config = [
       'timeout' => 0,                                 // The API timeout. In seconds (default 0 to wait indefinitely). (optional)
       'connect_timeout' => 0,                         // The API connection timeout. In seconds (default 0 to wait indefinitely) (optional)
       'version' => null,                              // The API version. (Default null). (optional)
-      'handler' => null                               // The callable Handler or HandlerStack. (Default null). (optional)
-      'features' => null                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'handler' => null,                               // The callable Handler or HandlerStack. (Default null). (optional)
+      'features' => null,                              // A set of additional features [e.g. lucene search]. (Default null). (optional)
+      'guzzle' => null,                                // Additional Guzzle Request Options. These options can overwrite some default options (Default null). (optional)
 ];
 ```
+**UPDATE (v1.9.0):** a new config parameter called "guzzle" is introduced, which is intended to pass additional guzzle request options to the call. These options will take precedence over the default configs like uri, auth and timeouts, but some other options like query, fome_params and json will be overwritten by the function if present.
 **UPDATE (v1.7.0):** the new items called `features` is added to the configuration array. As of now, it is meant to hanlde the toggle behavior to enable/disable Lucene search endpoint simply by adding `'features' => ['lucene' => true]`. Just keep in mind that this endpoint id off by default and won't work in Opencast 16 onwards. Therefore, developer must be very careful to use this feature and to toggle it!
 
 NOTE: the configuration for presentation (`engage` node) responsible for search has to follow the same definition as normal config. But in case any parameter is missing, the value will be taken from the main config param.