Added response headers to API->response_headers

Author: phpipam

php-client/class.phpipam-api.php

@@ -200,6 +200,12 @@ class phpipam_api_client  {
         "message" => ""
     );
 
+    /**
+     * Reponse headers
+     *
+     * @var array
+     */
+    public $response_headers = array ();
 
 
 
@@ -538,7 +544,7 @@ public function set_api_controller ($controller = false) {
      * @return void
      */
     public function set_api_identifiers ($identifiers) {
-        $this->api_server_identifiers = false;         // clear this to forget any previous settings 
+        $this->api_server_identifiers = false;         // clear this to forget any previous settings
         if(is_array($identifiers)) {
             if(sizeof($identifiers)>0 && !$this->api_encrypt) {
                 // reset
@@ -624,6 +630,8 @@ public function execute ($method = false, $controller = false, $identifiers = ar
             // save result
             $this->result = (array) $res;
         }
+        // save reult
+        $this->curl_save_headers ();
     }
 
     /**
@@ -654,7 +662,9 @@ private function curl_set_connection ($token_file) {
                     CURLOPT_USERAGENT => 'phpipam-api php class',
                     // ssl
                     CURLOPT_SSL_VERIFYHOST => false,
-                    CURLOPT_SSL_VERIFYPEER => false
+                    CURLOPT_SSL_VERIFYPEER => false,
+                    // save headers
+                    CURLINFO_HEADER_OUT => true
                 )
             );
         }
@@ -824,6 +834,17 @@ private function curl_execute () {
         }
     }
 
+    /**
+     * Store result code
+     *
+     * @method curl_save_result_code
+     * @return void
+     */
+    private function curl_save_headers () {
+        // save result and result code
+        $this->response_headers = curl_getinfo($this->Connection);
+    }
+
     /**
      * send authenticate request and save token if provided, otherwise throw error.
      *

php-client/example.php

@@ -16,15 +16,22 @@
 # debug - only to debug curl
 $API->set_debug (true);
 # execute - result is stored to $API->result, save it to own array if multiple calls needed after execute
-
-$API->execute ("POST", "addresses", array("first_free", "7"), array(), $token_file);
-
-
-// $API->execute ("DELETE", "subnets", array(7, "permissions"), array(), $token_file);
-// $API->execute ("POST", "vrf", array(), array("number"=>"114","name"=>"API"), $token_file);
-# ger result
+$API->execute ("GET", "addresses", array("first_free", "7"), array(), $token_file);
+#  get result
 $result = $API->get_result();
 
+/**
+ * Some examples
+ *
+ * Delete, POST examples
+ * $API->execute ("DELETE", "subnets", array(7, "permissions"), array(), $token_file);
+ * $API->execute ("POST", "vrf", array(), array("number"=>"114","name"=>"API"), $token_file);
+ *
+ * Get headers in array
+ * $response_headers = $API->response_headers ();
+ */
+
 # print result
+print_r($response_headers);
 print_r(json_decode($result, true));
 ?>