Merge pull request #61 from Jhut89/custom_curl_settings

Add custom curl settings options

Author: Jhut89

src/Mailchimp.php

@@ -53,7 +53,9 @@ public function account()
 
     /**
      * Retrieves a new AuthorizedApps instance.
+     *
      * @param null $app_id The ID for an app if retrieving an instance
+     *
      * @return Resources\AuthorizedApps
      */
     public function apps($app_id = null)
@@ -63,6 +65,7 @@ public function apps($app_id = null)
 
     /**
      * @param null $workflow_id
+     *
      * @return Resources\Automations
      */
     public function automations($workflow_id = null)
@@ -72,6 +75,7 @@ public function automations($workflow_id = null)
 
     /**
      * @param null $batch_id
+     *
      * @return Resources\BatchOperations
      */
     public function batches($batch_id = null)
@@ -81,6 +85,7 @@ public function batches($batch_id = null)
 
     /**
      * @param null $batch_webhook_id
+     *
      * @return Resources\BatchWebhooks
      */
     public function batchWebhooks($batch_webhook_id = null)
@@ -90,6 +95,7 @@ public function batchWebhooks($batch_webhook_id = null)
 
     /**
      * @param null $folder_id
+     *
      * @return Resources\CampaignFolders
      */
     public function campaignFolders($folder_id = null)
@@ -99,6 +105,7 @@ public function campaignFolders($folder_id = null)
 
     /**
      * @param null $campaign_id
+     *
      * @return Resources\Campaigns
      */
     public function campaigns($campaign_id = null)
@@ -108,6 +115,7 @@ public function campaigns($campaign_id = null)
 
     /**
      * @param null $site_id
+     *
      * @return Resources\ConnectedSites
      */
     public function connectedSites($site_id = null)
@@ -117,6 +125,7 @@ public function connectedSites($site_id = null)
 
     /**
      * @param null $conversation_id
+     *
      * @return Resources\Conversations
      */
     public function conversations($conversation_id = null)
@@ -127,6 +136,7 @@ public function conversations($conversation_id = null)
 
     /**
      * @param null $store_id
+     *
      * @return Resources\EcommerceStores
      */
     public function ecommerceStores($store_id = null)
@@ -136,6 +146,7 @@ public function ecommerceStores($store_id = null)
 
     /**
      * @param null $outreach_id
+     *
      * @return Resources\FacebookAds
      */
     public function facebookAds($outreach_id = null)
@@ -145,6 +156,7 @@ public function facebookAds($outreach_id = null)
 
     /**
      * @param null $file_id
+     *
      * @return Resources\FileManagerFiles
      */
     public function fileManagerFiles($file_id = null)
@@ -154,6 +166,7 @@ public function fileManagerFiles($file_id = null)
 
     /**
      * @param null $folder_id
+     *
      * @return Resources\FileManagerFolders
      */
     public function fileManagerFolders($folder_id = null)
@@ -163,6 +176,7 @@ public function fileManagerFolders($folder_id = null)
 
     /**
      * @param null $outreach_id
+     *
      * @return Resources\GoogleAds
      */
     public function googleAds($outreach_id = null)
@@ -172,6 +186,7 @@ public function googleAds($outreach_id = null)
 
     /**
      * @param null $page_id
+     *
      * @return Resources\LandingPages
      */
     public function landingPages($page_id = null)
@@ -181,6 +196,7 @@ public function landingPages($page_id = null)
 
     /**
      * @param null $list_id
+     *
      * @return Resources\Lists
      */
     public function lists($list_id = null)
@@ -198,6 +214,7 @@ public function ping()
 
     /**
      * @param null $campaign_id
+     *
      * @return Resources\Reports
      */
     public function reports($campaign_id = null)
@@ -223,6 +240,7 @@ public function searchMembers()
 
     /**
      * @param null $folder_id
+     *
      * @return Resources\TemplateFolders
      */
     public function templateFolders($folder_id = null)
@@ -232,6 +250,7 @@ public function templateFolders($folder_id = null)
 
     /**
      * @param null $template_id
+     *
      * @return Resources\Templates
      */
     public function templates($template_id = null)
@@ -252,6 +271,7 @@ public function verifiedDomains($domain_name = null)
     /**
      * @param $client_id
      * @param $redirect_uri
+     *
      * @return string
      */
     public static function getAuthUrl(
@@ -273,6 +293,7 @@ public static function getAuthUrl(
      * @param $client_id
      * @param $client_sec
      * @param $redirect_uri
+     *
      * @return string
      * @throws MailchimpException
      */
@@ -298,6 +319,7 @@ public static function oauthExchange(
 
     /**
      * @param $oauth_string
+     *
      * @return mixed
      * @throws MailchimpException
      */
@@ -324,6 +346,7 @@ private static function requestAccessToken($oauth_string)
 
     /**
      * @param $access_token
+     *
      * @return string
      * @throws MailchimpException
      */
@@ -344,7 +367,10 @@ private static function requestKeyFromToken($access_token)
 
     /**
      * @param MailchimpRequest $request
+     *
      * @return MailchimpConnection
+     *
+     * @throws MailchimpException
      */
     protected static function getStaticConnection(MailchimpRequest $request)
     {

src/Requests/HttpRequest.php

@@ -12,6 +12,7 @@ interface HttpRequest
     /**
      * @param $name
      * @param $value
+     *
      * @return mixed
      */
     public function setOption($name, $value);
@@ -23,6 +24,7 @@ public function executeCurl();
 
     /**
      * @param $name
+     *
      * @return mixed
      */
     public function getInfo($name);

src/Requests/MailchimpConnection.php

@@ -81,8 +81,11 @@ class MailchimpConnection implements HttpRequest
 
     /**
      * MailchimpConnection constructor.
-     * @param MailchimpRequest $request
+     *
+     * @param MailchimpRequest       $request
      * @param MailchimpSettings|null $settings
+     *
+     * @throws MailchimpException
      */
     public function __construct(MailchimpRequest &$request, MailchimpSettings &$settings = null)
     {
@@ -100,7 +103,10 @@ public function __construct(MailchimpRequest &$request, MailchimpSettings &$sett
 
     /**
      * Prepares this connections handle for execution
+     *
      * @return void
+     *
+     * @throws MailchimpException
      */
     private function prepareHandle()
     {
@@ -124,6 +130,23 @@ private function prepareHandle()
 
         // set the callback to run against each of the response headers
         $this->setOption(CURLOPT_HEADERFUNCTION, [&$this, "parseResponseHeader"]);
+
+        // if an custom curl settings are present set them now
+        $this->setCustomHandleOptions($this->current_settings->getCustomCurlSettings());
+    }
+
+    /**
+     * Set custom curl handler options
+     *
+     * @param array $options
+     */
+    private function setCustomHandleOptions(array $options)
+    {
+        if (!empty($options)) {
+            foreach ($options as $option => $value) {
+                $this->setOption($option, $value);
+            }
+        }
     }
 
     /**
@@ -156,8 +179,8 @@ private function setHandlerOptionsForMethod()
 
     /**
      * Executes a connection with the current request and settings
-     * @throws MailchimpException
      * @return MailchimpResponse
+     * @throws MailchimpException
      */
     public function execute()
     {
@@ -167,7 +190,7 @@ public function execute()
         }
 
         $this->http_code = $this->getInfo(CURLINFO_HTTP_CODE);
-        $head_len  = $this->getInfo(CURLINFO_HEADER_SIZE);
+        $head_len = $this->getInfo(CURLINFO_HEADER_SIZE);
         $this->response_body = substr(
             $this->response,
             $head_len,
@@ -193,7 +216,9 @@ public function execute()
 
     /**
      * Gets the currently set curl options by key
+     *
      * @param $key
+     *
      * @return mixed
      */
     public function getCurrentOption($key)
@@ -204,6 +229,7 @@ public function getCurrentOption($key)
     /**
      * Bulk set curl options
      * Update current settings
+     *
      * @param array $options
      */
     public function setCurrentOptions($options)
@@ -254,6 +280,7 @@ public function close()
      *
      * @param $handle
      * @param $header
+     *
      * @return int
      */
     private function parseResponseHeader($handle, $header)
@@ -263,7 +290,7 @@ private function parseResponseHeader($handle, $header)
         if (count($header_array) == 2) {
             $this->pushToHeaders($header_array);
         }
-        
+
         return $header_length;
     }