Merge pull request php-curl-class#216 from zachborboa/master

zachborboa · zachborboa · commit 1dc846846462 · 2015-07-31T00:28:16.000-07:00
Fix php-curl-class#191: Update naming convention to $camelCase for class member variables
diff --git a/README.md b/README.md
@@ -49,14 +49,14 @@ $curl->setCookie('key', 'value');
 $curl->get('http://www.example.com/');
 
 if ($curl->error) {
-    echo 'Error: ' . $curl->error_code . ': ' . $curl->error_message;
+    echo 'Error: ' . $curl->errorCode . ': ' . $curl->errorMessage;
 }
 else {
     echo $curl->response;
 }
 
-var_dump($curl->request_headers);
-var_dump($curl->response_headers);
+var_dump($curl->requestHeaders);
+var_dump($curl->responseHeaders);
 ```
 
 ```php
@@ -105,8 +105,8 @@ $curl->download('https://www.example.com/image.png', '/tmp/myimage.png');
 // Case-insensitive access to headers.
 $curl = new Curl();
 $curl->download('https://www.example.com/image.png', '/tmp/myimage.png');
-echo $curl->response_headers['Content-Type'] . "\n"; // image/png
-echo $curl->response_headers['CoNTeNT-TyPE'] . "\n"; // image/png
+echo $curl->responseHeaders['Content-Type'] . "\n"; // image/png
+echo $curl->responseHeaders['CoNTeNT-TyPE'] . "\n"; // image/png
 ```
 
 ```php
@@ -129,8 +129,8 @@ $multi_curl->success(function($instance) {
 });
 $multi_curl->error(function($instance) {
     echo 'call to "' . $instance->url . '" was unsuccessful.' . "\n";
-    echo 'error code: ' . $instance->error_code . "\n";
-    echo 'error message: ' . $instance->error_message . "\n";
+    echo 'error code: ' . $instance->errorCode . "\n";
+    echo 'error message: ' . $instance->errorMessage . "\n";
 });
 $multi_curl->complete(function($instance) {
     echo 'call completed' . "\n";
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -173,8 +173,8 @@ $curl->setHeader('X-Requested-With', 'XMLHttpRequest');
 $curl->get('https://www.example.com/');
 
 // Case-insensitive access to headers.
-echo $curl->request_headers['X-Requested-With'] . "\n"; // XMLHttpRequest
-echo $curl->request_headers['x-ReQUeStED-wiTH'] . "\n"; // XMLHttpRequest
+echo $curl->requestHeaders['X-Requested-With'] . "\n"; // XMLHttpRequest
+echo $curl->requestHeaders['x-ReQUeStED-wiTH'] . "\n"; // XMLHttpRequest
 ```
 
 ## Response header
@@ -185,8 +185,8 @@ $curl = new Curl();
 $curl->get('https://www.example.com/image.png');
 
 // Case-insensitive access to headers.
-echo $curl->response_headers['Content-Type'] . "\n"; // image/png
-echo $curl->response_headers['CoNTeNT-TyPE'] . "\n"; // image/png
+echo $curl->responseHeaders['Content-Type'] . "\n"; // image/png
+echo $curl->responseHeaders['CoNTeNT-TyPE'] . "\n"; // image/png
 ```
 
 ## Response body
@@ -224,8 +224,8 @@ $curl = new Curl();
 $curl->get('https://www.example.com/404');
 
 if ($curl->error) {
-    echo 'Error code: ' . $curl->error_code . "\n"; // 404
-    echo 'Error message: ' . $curl->error_message . "\n"; // HTTP/1.1 404 Not Found
+    echo 'Error code: ' . $curl->errorCode . "\n"; // 404
+    echo 'Error message: ' . $curl->errorMessage . "\n"; // HTTP/1.1 404 Not Found
 }
 else {
     echo $curl->response;
@@ -245,8 +245,8 @@ $curl->success(function($instance) {
 });
 $curl->error(function($instance) {
     echo 'call was unsuccessful.' . "\n";
-    echo 'error code:' . $instance->error_code . "\n";
-    echo 'error message:' . $instance->error_message . "\n";
+    echo 'error code:' . $instance->errorCode . "\n";
+    echo 'error message:' . $instance->errorMessage . "\n";
 });
 $curl->complete(function($instance) {
     echo 'call completed' . "\n";
diff --git a/examples/gmail_send_email.php b/examples/gmail_send_email.php
@@ -75,6 +75,6 @@
         'approval_prompt' => 'force',
     ));
 
-    $url = $curl->response_headers['Location'];
+    $url = $curl->responseHeaders['Location'];
     echo '<a href="' . $url . '">Continue</a>';
 }
diff --git a/examples/google_plus_profile.php b/examples/google_plus_profile.php
@@ -62,6 +62,6 @@
         'approval_prompt' => 'force',
     ));
 
-    $url = $curl->response_headers['Location'];
+    $url = $curl->responseHeaders['Location'];
     echo '<a href="' . $url . '">Continue</a>';
 }
diff --git a/examples/instagram_popular_media.php b/examples/instagram_popular_media.php
@@ -28,7 +28,7 @@
     ));
 
     if ($curl->error) {
-        echo $curl->response->error_type . ': ' . $curl->response->error_message . '<br />';
+        echo $curl->response->error_type . ': ' . $curl->response->errorMessage . '<br />';
         echo '<a href="?">Try again?</a>';
         exit;
     }
diff --git a/examples/multi_curl_get_callbacks.php b/examples/multi_curl_get_callbacks.php
@@ -13,8 +13,8 @@
 });
 $multi_curl->error(function($instance) {
     echo 'call to "' . $instance->url . '" was unsuccessful.' . "\n";
-    echo 'error code: ' . $instance->error_code . "\n";
-    echo 'error message: ' . $instance->error_message . "\n";
+    echo 'error code: ' . $instance->errorCode . "\n";
+    echo 'error message: ' . $instance->errorMessage . "\n";
 });
 $multi_curl->complete(function($instance) {
     echo 'call completed' . "\n";
diff --git a/examples/upload_file.php b/examples/upload_file.php
@@ -11,7 +11,7 @@
 ));
 
 if ($curl->error) {
-    echo 'Error: ' . $curl->error_message . "\n";
+    echo 'Error: ' . $curl->errorMessage . "\n";
 } else {
     echo 'Success' . "\n";
 }
diff --git a/scripts/bump_major_version.php b/scripts/bump_major_version.php
@@ -8,11 +8,6 @@
 
 foreach(
     array(
-        array(
-            dirname(__FILE__) . '/../composer.json',
-            '/"version": "(?:\d+.\d+.\d+)"/',
-            '"version": "' . $new_version . '"',
-        ),
         array(
             dirname(__FILE__) . '/../src/Curl/Curl.php',
             '/const VERSION = \'(?:\d+.\d+.\d+)\';/',
diff --git a/scripts/bump_minor_version.php b/scripts/bump_minor_version.php
@@ -8,11 +8,6 @@
 
 foreach(
     array(
-        array(
-            dirname(__FILE__) . '/../composer.json',
-            '/"version": "(?:\d+.\d+.\d+)"/',
-            '"version": "' . $new_version . '"',
-        ),
         array(
             dirname(__FILE__) . '/../src/Curl/Curl.php',
             '/const VERSION = \'(?:\d+.\d+.\d+)\';/',
diff --git a/scripts/bump_patch_version.php b/scripts/bump_patch_version.php
@@ -8,11 +8,6 @@
 
 foreach(
     array(
-        array(
-            dirname(__FILE__) . '/../composer.json',
-            '/"version": "(?:\d+.\d+.\d+)"/',
-            '"version": "' . $new_version . '"',
-        ),
         array(
             dirname(__FILE__) . '/../src/Curl/Curl.php',
             '/const VERSION = \'(?:\d+.\d+.\d+)\';/',
diff --git a/scripts/v4_migration.php b/scripts/v4_migration.php
@@ -0,0 +1,93 @@
+<?php
+
+// Migrate pre-4.x.x php scripts to use current naming convention of $camelCase
+// for properties / class member variables. To use, change into the directory
+// containing php files that you wish to update and run this script. Example:
+// $ cd /path/to/project
+// $ php ../php-curl-class/scripts/v4_migration.php
+
+$cwd = getcwd();
+echo 'Checking current directory "' . $cwd . '" for possible changes.' . "\n";
+
+$results = array(
+    'errors' => array(),
+    'files_found' => array(),
+    'files_to_change' => array(),
+);
+
+$migrations = array(
+    'error_code' => 'errorCode',
+    'error_message' => 'errorMessage',
+    'curl_error' => 'curlError',
+    'curl_error_code' => 'curlErrorCode',
+    'curl_error_message' => 'curlErrorMessage',
+    'http_error' => 'httpError',
+    'http_status_code' => 'httpStatusCode',
+    'http_error_message' => 'httpErrorMessage',
+    'base_url' => 'baseUrl',
+    'request_headers' => 'requestHeaders',
+    'response_headers' => 'responseHeaders',
+    'raw_response_headers' => 'rawResponseHeaders',
+    'raw_response' => 'rawResponse',
+    'before_send_function' => 'beforeSendFunction',
+    'download_complete_function' => 'downloadCompleteFunction',
+);
+
+$directory = new RecursiveDirectoryIterator($cwd);
+$iterator = new RecursiveIteratorIterator($directory);
+$regex = new RegexIterator($iterator, '/^.+\.php$/i', RecursiveRegexIterator::GET_MATCH);
+foreach ($regex as $file) {
+    $filepath = $file['0'];
+    $results['files_found'][] = $filepath;
+    if ($filepath === __FILE__) {
+        continue;
+    }
+    $data = file_get_contents($filepath);
+    $short_path = str_replace($cwd, '', $filepath);
+    if ($data === false) {
+        $results['errors'][] = $filepath;
+        echo $short_path . ' [ERROR]' . "\n";
+    } else {
+        foreach ($migrations as $old => $new) {
+            if (!(strpos($data, '->' . $old) === false)) {
+                $results['files_to_change'][] = $filepath;
+                echo $short_path . "\n";
+                break;
+            }
+        }
+    }
+}
+
+foreach ($results as $name => $files) {
+    $results[$name . '_count'] = count($files);
+}
+$results['errors_count'] = count($results['errors']);
+$results['files_found_count'] = count($results['files_found']);
+$results['files_to_change_count'] = count($results['files_to_change']);
+
+if ($results['errors_count'] > 0) {
+    echo 'ERROR: Unable to read files.' . "\n";
+    exit(1);
+} else if ($results['files_found_count'] === 0) {
+    echo 'Current directory "' . $cwd . '"' . "\n";
+    echo 'ERROR: No read files found in current directory.' . "\n";
+    exit(1);
+} else if ($results['files_to_change_count'] === 0) {
+    echo 'OK: No files to change.' . "\n";
+    exit(0);
+} else if ($results['files_to_change_count'] > 0) {
+    echo $results['files_to_change_count'] . ' of ' . $results['files_found_count'] . ' files to change found.' . "\n";
+    echo 'Continue? [y/n] ';
+    if (!in_array(trim(fgets(STDIN)), array('y', 'Y'))) {
+        die();
+    }
+    foreach ($results['files_to_change'] as $filepath) {
+        $data = file_get_contents($filepath);
+        foreach ($migrations as $old => $new) {
+            $data = str_replace('->' . $old, '->' . $new, $data);
+        }
+        file_put_contents($filepath, $data);
+    }
+    echo 'Done' . "\n";
+    exit(0);
+}
diff --git a/src/Curl/Curl.php b/src/Curl/Curl.php
diff --git a/src/Curl/MultiCurl.php b/src/Curl/MultiCurl.php
diff --git a/tests/PHPCurlClass/Helper.php b/tests/PHPCurlClass/Helper.php
diff --git a/tests/PHPCurlClass/PHPCurlClassTest.php b/tests/PHPCurlClass/PHPCurlClassTest.php
diff --git a/tests/PHPCurlClass/PHPMultiCurlClassTest.php b/tests/PHPCurlClass/PHPMultiCurlClassTest.php

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,6 @@`
`75`	`75`	`'approval_prompt' => 'force',`
`76`	`76`	`));`
`77`	`77`
`78`		`- $url = $curl->response_headers['Location'];`
	`78`	`+ $url = $curl->responseHeaders['Location'];`
`79`	`79`	`echo '<a href="' . $url . '">Continue</a>';`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,6 @@`
`62`	`62`	`'approval_prompt' => 'force',`
`63`	`63`	`));`
`64`	`64`
`65`		`- $url = $curl->response_headers['Location'];`
	`65`	`+ $url = $curl->responseHeaders['Location'];`
`66`	`66`	`echo '<a href="' . $url . '">Continue</a>';`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`));`
`29`	`29`
`30`	`30`	`if ($curl->error) {`
`31`		`- echo $curl->response->error_type . ': ' . $curl->response->error_message . '<br />';`
	`31`	`+ echo $curl->response->error_type . ': ' . $curl->response->errorMessage . '<br />';`
`32`	`32`	`echo '<a href="?">Try again?</a>';`
`33`	`33`	`exit;`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`));`
`12`	`12`
`13`	`13`	`if ($curl->error) {`
`14`		`- echo 'Error: ' . $curl->error_message . "\n";`
	`14`	`+ echo 'Error: ' . $curl->errorMessage . "\n";`
`15`	`15`	`} else {`
`16`	`16`	`echo 'Success' . "\n";`
`17`	`17`	`}`