Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shuber/curl
A basic CURL wrapper for PHP
https://github.com/shuber/curl
Last synced: 18 days ago
JSON representation
A basic CURL wrapper for PHP
- Host: GitHub
- URL: https://github.com/shuber/curl
- Owner: shuber
- License: mit
- Created: 2008-05-07T18:05:24.000Z (over 16 years ago)
- Default Branch: master
- Last Pushed: 2022-04-27T00:25:59.000Z (over 2 years ago)
- Last Synced: 2024-11-10T22:16:25.434Z (about 1 month ago)
- Language: PHP
- Homepage:
- Size: 473 KB
- Stars: 462
- Watchers: 32
- Forks: 179
- Open Issues: 14
-
Metadata Files:
- Readme: README.markdown
- License: MIT-LICENSE
Awesome Lists containing this project
- favorite-link - PHP 的基本 CURL 包装器。
README
# curl
A basic CURL wrapper for PHP (see [http://php.net/curl](http://php.net/curl) for more information about the libcurl extension for PHP)
## Installation
Click the `download` link above or `git clone git://github.com/shuber/curl.git`
## Usage
### Initialization
Simply require and initialize the `Curl` class like so:
require_once 'curl.php';
$curl = new Curl;### Performing a Request
The Curl object supports 5 types of requests: HEAD, GET, POST, PUT, and DELETE. You must specify a url to request and optionally specify an associative array or string of variables to send along with it.
$response = $curl->head($url, $vars = array());
$response = $curl->get($url, $vars = array()); # The Curl object will append the array of $vars to the $url as a query string
$response = $curl->post($url, $vars = array());
$response = $curl->put($url, $vars = array());
$response = $curl->delete($url, $vars = array());To use a custom request methods, you can call the `request` method:
$response = $curl->request('YOUR_CUSTOM_REQUEST_TYPE', $url, $vars = array());
All of the built in request methods like `put` and `get` simply wrap the `request` method. For example, the `post` method is implemented like:
function post($url, $vars = array()) {
return $this->request('POST', $url, $vars);
}Examples:
$response = $curl->get('google.com?q=test');
# The Curl object will append '&some_variable=some_value' to the url
$response = $curl->get('google.com?q=test', array('some_variable' => 'some_value'));
$response = $curl->post('test.com/posts', array('title' => 'Test', 'body' => 'This is a test'));All requests return a CurlResponse object (see below) or false if an error occurred. You can access the error string with the `$curl->error()` method.
### The CurlResponse Object
A normal CURL request will return the headers and the body in one response string. This class parses the two and places them into separate properties.
For example
$response = $curl->get('google.com');
echo $response->body; # A string containing everything in the response except for the headers
print_r($response->headers); # An associative array containing the response headersWhich would display something like
Google.com
Some more html...
Array
(
[Http-Version] => 1.0
[Status-Code] => 200
[Status] => 200 OK
[Cache-Control] => private
[Content-Type] => text/html; charset=ISO-8859-1
[Date] => Wed, 07 May 2008 21:43:48 GMT
[Server] => gws
[Connection] => close
)
The CurlResponse class defines the magic [__toString()](http://php.net/__toString) method which will return the response body, so `echo $response` is the same as `echo $response->body`### Cookie Sessions
By default, cookies will be stored in a file called `curl_cookie.txt`. You can change this file's name by setting it like this
$curl->cookie_file = 'some_other_filename';
This allows you to maintain a session across requests
### Basic Configuration Options
You can easily set the referer or user-agent
$curl->referer = 'http://google.com';
$curl->user_agent = 'some user agent string';You may even set these headers manually if you wish (see below)
### Setting Custom Headers
You can set custom headers to send with the request
$curl->headers['Host'] = 12.345.678.90;
$curl->headers['Some-Custom-Header'] = 'Some Custom Value';### Setting Custom CURL request options
By default, the `Curl` object will follow redirects. You can disable this by setting:
$curl->follow_redirects = false;
You can set/override many different options for CURL requests (see the [curl_setopt documentation](http://php.net/curl_setopt) for a list of them)
# any of these will work
$curl->options['AUTOREFERER'] = true;
$curl->options['autoreferer'] = true;
$curl->options['CURLOPT_AUTOREFERER'] = true;
$curl->options['curlopt_autoreferer'] = true;## Testing
Uses [ztest](http://github.com/jaz303/ztest), simply download it to `path/to/curl/test/ztest` (or anywhere else in your php include_path)
Then run `test/runner.php`
## Contact
Problems, comments, and suggestions all welcome: [[email protected]](mailto:[email protected])