geckon01/php-curl-class
1
0
Fork 0
mirror of https://github.com/php-curl-class/php-curl-class.git synced 2026-09-02 05:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #139 from zachborboa/master

Browse Source 
Clean up
This commit is contained in:
Zach Borboa
2015-02-15 02:05:23 +07:00
parent b0dd2d4860 9de0754409
commit 60e1cb9287
3 changed files with 296 additions and 293 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3
View File
@@ -183,6 +183,9 @@ Curl::setUserAgent($user_agent)
Curl::success($callback)
Curl::unsetHeader($key)
Curl::verbose($on = true)
Curl::http_build_multi_query($data, $key = null)
Curl::is_array_assoc($array)
Curl::is_array_multidim($array)
```
### Experimental Methods
src/Curl/Curl.php
+278 -278
View File
@@ -7,19 +7,6 @@ class Curl
const VERSION = '3.0.2';
const DEFAULT_TIMEOUT = 30;
private $cookies = array();
private $headers = array();
private $options = array();
public $before_send_function = null;
private $success_function = null;
private $error_function = null;
private $complete_function = null;
private $json_decoder = null;
private $json_pattern = '~^application/(?:json|vnd\.api\+json)~i';
private $xml_pattern = '~^(?:text/|application/(?:atom\+|rss\+)?)xml~i';
public $curl;
public $id = null;
@@ -43,6 +30,19 @@ class Curl
public $response = null;
public $raw_response = null;
public $before_send_function = null;
private $success_function = null;
private $error_function = null;
private $complete_function = null;
private $cookies = array();
private $headers = array();
private $options = array();
private $json_decoder = null;
private $json_pattern = '~^application/(?:json|vnd\.api\+json)~i';
private $xml_pattern = '~^(?:text/|application/(?:atom\+|rss\+)?)xml~i';
public function __construct()
{
if (!extension_loaded('curl')) {
@@ -60,46 +60,28 @@ class Curl
$this->headers = new CaseInsensitiveArray();
}
public function get($url, $data = array())
public function beforeSend($callback)
{
$this->setURL($url, $data);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'GET');
$this->setOpt(CURLOPT_HTTPGET, true);
return $this->exec();
$this->before_send_function = $callback;
}
public function post($url, $data = array())
public function call($function)
{
if (is_array($data) && empty($data)) {
$this->unsetHeader('Content-Length');
if (is_callable($function)) {
call_user_func_array($function, array($this));
}
$this->setURL($url);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'POST');
$this->setOpt(CURLOPT_POST, true);
$this->setOpt(CURLOPT_POSTFIELDS, $this->postfields($data));
return $this->exec();
}
public function put($url, $data = array())
public function close()
{
$this->setURL($url);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'PUT');
$put_data = $this->postfields($data);
if (empty($this->options[CURLOPT_INFILE]) && empty($this->options[CURLOPT_INFILESIZE])) {
$this->setHeader('Content-Length', strlen($put_data));
if (is_resource($this->curl)) {
curl_close($this->curl);
}
$this->setOpt(CURLOPT_POSTFIELDS, $put_data);
return $this->exec();
}
public function patch($url, $data = array())
public function complete($callback)
{
$this->setURL($url);
$this->unsetHeader('Content-Length');
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'PATCH');
$this->setOpt(CURLOPT_POSTFIELDS, $data);
return $this->exec();
$this->complete_function = $callback;
}
public function delete($url, $data = array())
@@ -110,22 +92,6 @@ class Curl
return $this->exec();
}
public function head($url, $data = array())
{
$this->setURL($url, $data);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'HEAD');
$this->setOpt(CURLOPT_NOBODY, true);
return $this->exec();
}
public function options($url, $data = array())
{
$this->setURL($url, $data);
$this->unsetHeader('Content-Length');
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'OPTIONS');
return $this->exec();
}
public function download($url, $filename)
{
$fh = fopen($filename, 'wb');
@@ -153,80 +119,179 @@ class Curl
return ! $this->error;
}
public function error($callback)
{
$this->error_function = $callback;
}
public function exec($ch = null)
{
$target = $ch === null ? $this : $ch;
if (!($ch === null)) {
$this->raw_response = curl_multi_getcontent($ch);
} else {
$this->call($this->before_send_function);
$this->raw_response = curl_exec($this->curl);
$this->curl_error_code = curl_errno($this->curl);
}
$this->curl_error_message = curl_error($this->curl);
$this->curl_error = !($this->curl_error_code === 0);
$this->http_status_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE);
$this->http_error = in_array(floor($this->http_status_code / 100), array(4, 5));
$this->error = $this->curl_error || $this->http_error;
$this->error_code = $this->error ? ($this->curl_error ? $this->curl_error_code : $this->http_status_code) : 0;
$this->request_headers = $this->parseRequestHeaders(curl_getinfo($this->curl, CURLINFO_HEADER_OUT));
$this->response_headers = $this->parseResponseHeaders($this->raw_response_headers);
list($this->response, $this->raw_response) = $this->parseResponse($this->response_headers, $this->raw_response);
$this->http_error_message = '';
if ($this->error) {
if (isset($this->response_headers['Status-Line'])) {
$this->http_error_message = $this->response_headers['Status-Line'];
}
}
$this->error_message = $this->curl_error ? $this->curl_error_message : $this->http_error_message;
if (!$this->error) {
$this->call($this->success_function);
} else {
$this->call($this->error_function);
}
$this->call($this->complete_function);
return $this->response;
}
public function get($url, $data = array())
{
$this->setURL($url, $data);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'GET');
$this->setOpt(CURLOPT_HTTPGET, true);
return $this->exec();
}
public function getOpt($option)
{
return $this->options[$option];
}
public function head($url, $data = array())
{
$this->setURL($url, $data);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'HEAD');
$this->setOpt(CURLOPT_NOBODY, true);
return $this->exec();
}
public function headerCallback($ch, $header)
{
$this->raw_response_headers .= $header;
return strlen($header);
}
public function options($url, $data = array())
{
$this->setURL($url, $data);
$this->unsetHeader('Content-Length');
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'OPTIONS');
return $this->exec();
}
public function patch($url, $data = array())
{
$this->setURL($url);
$this->unsetHeader('Content-Length');
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'PATCH');
$this->setOpt(CURLOPT_POSTFIELDS, $data);
return $this->exec();
}
public function post($url, $data = array())
{
if (is_array($data) && empty($data)) {
$this->unsetHeader('Content-Length');
}
$this->setURL($url);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'POST');
$this->setOpt(CURLOPT_POST, true);
$this->setOpt(CURLOPT_POSTFIELDS, $this->postfields($data));
return $this->exec();
}
public function postfields($data)
{
if (is_array($data)) {
if (self::is_array_multidim($data)) {
if (isset($this->headers['Content-Type']) &&
preg_match($this->json_pattern, $this->headers['Content-Type'])) {
$json_str = json_encode($data);
if (!($json_str === false)) {
$data = $json_str;
}
} else {
$data = self::http_build_multi_query($data);
}
} else {
$binary_data = false;
foreach ($data as $key => $value) {
// Fix "Notice: Array to string conversion" when $value in
// curl_setopt($ch, CURLOPT_POSTFIELDS, $value) is an array
// that contains an empty array.
if (is_array($value) && empty($value)) {
$data[$key] = '';
// Fix "curl_setopt(): The usage of the @filename API for
// file uploading is deprecated. Please use the CURLFile
// class instead".
} elseif (is_string($value) && strpos($value, '@') === 0) {
$binary_data = true;
if (class_exists('CURLFile')) {
$data[$key] = new \CURLFile(substr($value, 1));
}
} elseif ($value instanceof \CURLFile) {
$binary_data = true;
}
}
if (!$binary_data) {
if (isset($this->headers['Content-Type']) &&
preg_match($this->json_pattern, $this->headers['Content-Type'])) {
$json_str = json_encode($data);
if (!($json_str === false)) {
$data = $json_str;
}
} else {
$data = http_build_query($data);
}
}
}
}
return $data;
}
public function put($url, $data = array())
{
$this->setURL($url);
$this->setOpt(CURLOPT_CUSTOMREQUEST, 'PUT');
$put_data = $this->postfields($data);
if (empty($this->options[CURLOPT_INFILE]) && empty($this->options[CURLOPT_INFILESIZE])) {
$this->setHeader('Content-Length', strlen($put_data));
}
$this->setOpt(CURLOPT_POSTFIELDS, $put_data);
return $this->exec();
}
public function setBasicAuthentication($username, $password = '')
{
$this->setOpt(CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$this->setOpt(CURLOPT_USERPWD, $username . ':' . $password);
}
public function setHeader($key, $value)
{
$this->headers[$key] = $value;
$headers = array();
foreach ($this->headers as $key => $value) {
$headers[$key] = $value;
}
$this->setOpt(CURLOPT_HTTPHEADER, array_map(function($value, $key) {
return $key . ': ' . $value;
}, $headers, array_keys($headers)));
}
public function unsetHeader($key)
{
$this->setHeader($key, '');
unset($this->headers[$key]);
}
public function setDefaultUserAgent()
{
$user_agent = 'PHP-Curl-Class/' . self::VERSION . ' (+https://github.com/php-curl-class/php-curl-class)';
$user_agent .= ' PHP/' . PHP_VERSION;
$curl_version = curl_version();
$user_agent .= ' curl/' . $curl_version['version'];
$this->setUserAgent($user_agent);
}
public function setDefaultJsonDecoder()
{
$this->json_decoder = function($response) {
$json_obj = json_decode($response, false);
if (!($json_obj === null)) {
$response = $json_obj;
}
return $response;
};
}
public function setJsonDecoder($func)
{
$this->json_decoder = $func;
}
public function setUserAgent($user_agent)
{
$this->setOpt(CURLOPT_USERAGENT, $user_agent);
}
public function setTimeout($seconds)
{
$this->setOpt(CURLOPT_TIMEOUT, $seconds);
}
public function setDefaultTimeout()
{
$this->setTimeout(self::DEFAULT_TIMEOUT);
}
public function setReferer($referer)
{
$this->setReferrer($referer);
}
public function setReferrer($referrer)
{
$this->setOpt(CURLOPT_REFERER, $referrer);
}
public function setCookie($key, $value)
{
$this->cookies[$key] = $value;
@@ -243,6 +308,48 @@ class Curl
$this->setOpt(CURLOPT_COOKIEJAR, $cookie_jar);
}
public function setDefaultJsonDecoder()
{
$this->json_decoder = function($response) {
$json_obj = json_decode($response, false);
if (!($json_obj === null)) {
$response = $json_obj;
}
return $response;
};
}
public function setDefaultTimeout()
{
$this->setTimeout(self::DEFAULT_TIMEOUT);
}
public function setDefaultUserAgent()
{
$user_agent = 'PHP-Curl-Class/' . self::VERSION . ' (+https://github.com/php-curl-class/php-curl-class)';
$user_agent .= ' PHP/' . PHP_VERSION;
$curl_version = curl_version();
$user_agent .= ' curl/' . $curl_version['version'];
$this->setUserAgent($user_agent);
}
public function setHeader($key, $value)
{
$this->headers[$key] = $value;
$headers = array();
foreach ($this->headers as $key => $value) {
$headers[$key] = $value;
}
$this->setOpt(CURLOPT_HTTPHEADER, array_map(function($value, $key) {
return $key . ': ' . $value;
}, $headers, array_keys($headers)));
}
public function setJsonDecoder($func)
{
$this->json_decoder = $func;
}
public function setOpt($option, $value)
{
$required_options = array(
@@ -258,41 +365,19 @@ class Curl
return curl_setopt($this->curl, $option, $value);
}
public function getOpt($option)
public function setReferer($referer)
{
return $this->options[$option];
$this->setReferrer($referer);
}
public function verbose($on = true)
public function setReferrer($referrer)
{
$this->setOpt(CURLOPT_VERBOSE, $on);
$this->setOpt(CURLOPT_REFERER, $referrer);
}
public function close()
public function setTimeout($seconds)
{
if (is_resource($this->curl)) {
curl_close($this->curl);
}
}
public function beforeSend($callback)
{
$this->before_send_function = $callback;
}
public function success($callback)
{
$this->success_function = $callback;
}
public function error($callback)
{
$this->error_function = $callback;
}
public function complete($callback)
{
$this->complete_function = $callback;
$this->setOpt(CURLOPT_TIMEOUT, $seconds);
}
public function setURL($url, $data = array())
@@ -302,17 +387,37 @@ class Curl
$this->setOpt(CURLOPT_URL, $this->url);
}
public function setUserAgent($user_agent)
{
$this->setOpt(CURLOPT_USERAGENT, $user_agent);
}
public function success($callback)
{
$this->success_function = $callback;
}
public function unsetHeader($key)
{
$this->setHeader($key, '');
unset($this->headers[$key]);
}
public function verbose($on = true)
{
$this->setOpt(CURLOPT_VERBOSE, $on);
}
public function __destruct()
{
$this->close();
}
private function buildURL($url, $data = array())
{
return $url . (empty($data) ? '' : '?' . http_build_query($data));
}
public function headerCallback($ch, $header)
{
$this->raw_response_headers .= $header;
return strlen($header);
}
private function parseHeaders($raw_headers)
{
$raw_headers = preg_split('/\r\n/', $raw_headers, null, PREG_SPLIT_NO_EMPTY);
@@ -382,125 +487,6 @@ class Curl
return $response_headers;
}
public function postfields($data)
{
if (is_array($data)) {
if (self::is_array_multidim($data)) {
if (isset($this->headers['Content-Type']) &&
preg_match($this->json_pattern, $this->headers['Content-Type'])) {
$json_str = json_encode($data);
if (!($json_str === false)) {
$data = $json_str;
}
} else {
$data = self::http_build_multi_query($data);
}
} else {
$binary_data = false;
foreach ($data as $key => $value) {
// Fix "Notice: Array to string conversion" when $value in
// curl_setopt($ch, CURLOPT_POSTFIELDS, $value) is an array
// that contains an empty array.
if (is_array($value) && empty($value)) {
$data[$key] = '';
// Fix "curl_setopt(): The usage of the @filename API for
// file uploading is deprecated. Please use the CURLFile
// class instead".
} elseif (is_string($value) && strpos($value, '@') === 0) {
$binary_data = true;
if (class_exists('CURLFile')) {
$data[$key] = new \CURLFile(substr($value, 1));
}
} elseif ($value instanceof \CURLFile) {
$binary_data = true;
}
}
if (!$binary_data) {
if (isset($this->headers['Content-Type']) &&
preg_match($this->json_pattern, $this->headers['Content-Type'])) {
$json_str = json_encode($data);
if (!($json_str === false)) {
$data = $json_str;
}
} else {
$data = http_build_query($data);
}
}
}
}
return $data;
}
public function exec($ch = null)
{
$target = $ch === null ? $this : $ch;
if (!($ch === null)) {
$this->raw_response = curl_multi_getcontent($ch);
} else {
$this->call($this->before_send_function);
$this->raw_response = curl_exec($this->curl);
$this->curl_error_code = curl_errno($this->curl);
}
$this->curl_error_message = curl_error($this->curl);
$this->curl_error = !($this->curl_error_code === 0);
$this->http_status_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE);
$this->http_error = in_array(floor($this->http_status_code / 100), array(4, 5));
$this->error = $this->curl_error || $this->http_error;
$this->error_code = $this->error ? ($this->curl_error ? $this->curl_error_code : $this->http_status_code) : 0;
$this->request_headers = $this->parseRequestHeaders(curl_getinfo($this->curl, CURLINFO_HEADER_OUT));
$this->response_headers = $this->parseResponseHeaders($this->raw_response_headers);
list($this->response, $this->raw_response) = $this->parseResponse($this->response_headers, $this->raw_response);
$this->http_error_message = '';
if ($this->error) {
if (isset($this->response_headers['Status-Line'])) {
$this->http_error_message = $this->response_headers['Status-Line'];
}
}
$this->error_message = $this->curl_error ? $this->curl_error_message : $this->http_error_message;
if (!$this->error) {
$this->call($this->success_function);
} else {
$this->call($this->error_function);
}
$this->call($this->complete_function);
return $this->response;
}
public function call($function)
{
if (is_callable($function)) {
call_user_func_array($function, array($this));
}
}
public function __destruct()
{
$this->close();
}
public static function is_array_assoc($array)
{
return (bool)count(array_filter(array_keys($array), 'is_string'));
}
public static function is_array_multidim($array)
{
if (!is_array($array)) {
return false;
}
return (bool)count(array_filter($array, 'is_array'));
}
public static function http_build_multi_query($data, $key = null)
{
$query = array();
@@ -523,6 +509,20 @@ class Curl
return implode('&', $query);
}
public static function is_array_assoc($array)
{
return (bool)count(array_filter(array_keys($array), 'is_string'));
}
public static function is_array_multidim($array)
{
if (!is_array($array)) {
return false;
}
return (bool)count(array_filter($array, 'is_array'));
}
}
class CaseInsensitiveArray implements \ArrayAccess, \Countable, \Iterator
src/Curl/MultiCurl.php
+15 -15
View File
@@ -119,9 +119,18 @@ class MultiCurl
$this->before_send_function = $callback;
}
public function success($callback)
public function close()
{
$this->success_function = $callback;
foreach ($this->curls as $ch) {
$ch->close();
}
curl_multi_close($this->multi_curl);
}
public function complete($callback)
{
$this->complete_function = $callback;
}
public function error($callback)
@@ -129,9 +138,9 @@ class MultiCurl
$this->error_function = $callback;
}
public function complete($callback)
public function getOpt($option)
{
$this->complete_function = $callback;
return $this->options[$option];
}
public function setHeader($key, $value)
@@ -144,11 +153,6 @@ class MultiCurl
$this->options[$option] = $value;
}
public function getOpt($option)
{
return $this->options[$option];
}
public function start()
{
foreach ($this->curls as $ch) {
@@ -191,13 +195,9 @@ class MultiCurl
} while ($active > 0);
}
public function close()
public function success($callback)
{
foreach ($this->curls as $ch) {
$ch->close();
}
curl_multi_close($this->multi_curl);
$this->success_function = $callback;
}
public function __destruct()