9 Commits

Author SHA1 Message Date
Ahmad Nassri
b0df287d64 README fix 2015-04-08 17:36:02 -04:00
Ahmad Nassri
4221ee5138 setting custom curl options
- `Unirest\Request::curlOpt()`
- `Unirest\Request::curlOpts()`
- `Unirest\Request::clearCurlOpts()`

fixes #78
2015-04-08 17:35:14 -04:00
Ahmad Nassri
ec5828c8aa Merge pull request #77 from cristianp6/master
Fixed "Undefined variable: ch" and add cookie string support
2015-04-03 13:08:41 -04:00
cristianp6
0293eb258c Add cookie string support, aka CURLOPT_COOKIE 2015-04-03 12:04:49 +02:00
cristianp6
a1ed45be55 Fixed "Notice: Undefined variable: ch" on curl_setopt cookieFile 2015-04-03 11:16:17 +02:00
Ahmad Nassri
8da79e7898 updating README and fixing typo 2015-04-02 14:22:32 -04:00
Ahmad Nassri
217b436124 manually applying PR by @daydiff due to complex merge issues, closes #67 2015-04-02 14:11:23 -04:00
Ahmad Nassri
d508bd9628 Merge pull request #76 from vlakarados/master
Add PHP version to readme.md's requirements
2015-03-30 03:40:31 -04:00
Sergey Telshevsky
7116894dad Add PHP version to readme.md's requirements 2015-03-30 10:33:46 +03:00
3 changed files with 132 additions and 26 deletions

View File

@@ -22,6 +22,7 @@ Unirest is a set of lightweight HTTP libraries available in [multiple languages]
## Requirements
- [cURL](http://php.net/manual/en/book.curl.php)
- PHP 5.4+
## Installation
@@ -156,6 +157,22 @@ $response = Unirest\Request::get("http://mockbin.com/request", null, null, "user
**This has been deprecated, and will be completely removed in `v.3.0.0` please use the `Unirest\Request::auth()` method instead**
### Cookies
Set a cookie string to specify the contents of a cookie header. Multiple cookies are separated with a semicolon followed by a space (e.g., "fruit=apple; colour=red")
```php
Unirest\Request::cookie($cookie)
```
Set a cookie file path for enabling cookie reading and storing cookies across multiple sequence of requests.
```php
Unirest\Request::cookieFile($cookieFile)
```
`$cookieFile` must be a correct path with write permission.
### Request Object
```php
@@ -258,7 +275,7 @@ Unirest\Request::defaultHeader("Header1", "Value1");
Unirest\Request::defaultHeader("Header2", "Value2");
```
You can do set default headers in bulk:
You can set default headers in bulk by passing an array:
```php
Unirest\Request::defaultHeaders(array(
@@ -273,6 +290,28 @@ You can clear the default headers anytime with:
Unirest\Request::clearDefaultHeaders();
```
#### Default cURL Options
You can set default [cURL options](http://php.net/manual/en/function.curl-setopt.php) that will be sent on every request:
```php
Unirest\Request::curlOpt(CURLOPT_COOKIE, "foo=bar");
```
You can set options bulk by passing an array:
```php
Unirest\Request::curlOpts(array(
CURLOPT_COOKIE => "foo=bar"
));
```
You can clear the default options anytime with:
```php
Unirest\Request::clearCurlOpts();
```
#### SSL validation
You can explicitly enable or disable SSL certificate validation when consuming an SSL protected endpoint:

View File

@@ -7,11 +7,14 @@ use Unirest\Response;
class Request
{
private static $cookie = null;
private static $cookieFile = null;
private static $curlOpts = array();
private static $defaultHeaders = array();
private static $handle = null;
private static $jsonOpts = array();
private static $verifyPeer = true;
private static $socketTimeout = null;
private static $defaultHeaders = array();
private static $verifyPeer = true;
private static $auth = array (
'user' => '',
@@ -70,11 +73,7 @@ class Request
*/
public static function defaultHeaders($headers)
{
foreach ($headers as $name => $value) {
self::$defaultHeaders[$name] = $value;
}
return $headers;
return array_merge(self::$defaultHeaders, $headers);
}
/**
@@ -88,6 +87,43 @@ class Request
return self::$defaultHeaders[$name] = $value;
}
/**
* Clear all the default headers
*/
public static function clearDefaultHeaders()
{
return self::$defaultHeaders = array();
}
/**
* Set curl options to send on every request
*
* @param array $options options array
*/
public static function curlOpts($opts)
{
return array_merge(self::$curlOpts, $opts);
}
/**
* Set a new default header to send on every request
*
* @param string $name header name
* @param string $value header value
*/
public static function curlOpt($name, $value)
{
return self::$curlOpts[$name] = $value;
}
/**
* Clear all the default headers
*/
public static function clearCurlOpts()
{
return self::$curlOpts = array();
}
/**
* Set a Mashape key to send on every request as a header
* Obtain your Mashape key by browsing one of your Mashape applications on https://www.mashape.com
@@ -103,11 +139,25 @@ class Request
}
/**
* Clear all the default headers
* Set a coockie string for enabling coockie handling
*
* @param string $cookie
*/
public static function clearDefaultHeaders()
public static function cookie($cookie)
{
return self::$defaultHeaders = array();
self::$cookie = $cookie;
}
/**
* Set a coockie file path for enabling coockie handling
*
* $cookieFile must be a correct path with write permission
*
* @param string $cookieFile - path to file for saving cookie
*/
public static function cookieFile($cookieFile)
{
self::$cookieFile = $cookieFile;
}
/**
@@ -326,6 +376,9 @@ class Request
{
self::$handle = curl_init();
// start with default options
curl_setopt_array(self::$handle, self::$curlOpts);
if ($method !== Method::GET) {
curl_setopt(self::$handle, CURLOPT_CUSTOMREQUEST, $method);
@@ -360,6 +413,15 @@ class Request
curl_setopt(self::$handle, CURLOPT_TIMEOUT, self::$socketTimeout);
}
if (self::$cookie) {
curl_setopt(self::$handle, CURLOPT_COOKIE, self::$cookie);
}
if (self::$cookieFile) {
curl_setopt(self::$handle, CURLOPT_COOKIEFILE, self::$cookieFile);
curl_setopt(self::$handle, CURLOPT_COOKIEJAR, self::$cookieFile);
}
// supporting deprecated http auth method
if (!empty($username)) {
curl_setopt_array(self::$handle, array(
@@ -403,9 +465,15 @@ class Request
return new Response($httpCode, $body, $header, self::$jsonOpts);
}
public static function getInfo()
public static function getInfo($opt = false)
{
return curl_getinfo(self::$handle);
if ($opt) {
$info = curl_getinfo(self::$handle, $opt);
} else {
$info = curl_getinfo(self::$handle);
}
return $info;
}
public static function getCurlHandle()

View File

@@ -16,6 +16,17 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
$this->assertEquals($result['file'], $file);
}
public function testCurlOpts()
{
Unirest\Request::curlOpt(CURLOPT_COOKIE, 'foo=bar');
$response = Unirest\Request::get('http://mockbin.com/request');
$this->assertTrue(property_exists($response->body->cookies, 'foo'));
Unirest\Request::clearCurlOpts();
}
/**
* @expectedException Exception
*/
@@ -23,23 +34,11 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
{
Unirest\Request::timeout(1);
Unirest\Request::get('http://mockbin.com/delay/3000');
Unirest\Request::get('http://mockbin.com/delay/1000');
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
}
/*
public function testTimeoutSuccess()
{
Unirest\Request::timeout(3);
$response = Unirest\Request::get('http://mockbin.com/delay/2000');
$this->assertEquals(200, $response->code);
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
}
*/
public function testDefaultHeader()
{
Unirest\Request::defaultHeader('Hello', 'custom');