Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-mod/curl
This library provides an object-oriented and dependency free wrapper of the PHP cURL extension.
https://github.com/php-mod/curl
curl hacktoberfest php
Last synced: about 12 hours ago
JSON representation
This library provides an object-oriented and dependency free wrapper of the PHP cURL extension.
- Host: GitHub
- URL: https://github.com/php-mod/curl
- Owner: php-mod
- License: mit
- Created: 2013-11-02T23:32:24.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-08-24T05:37:27.000Z (4 months ago)
- Last Synced: 2024-10-29T17:31:17.655Z (about 1 month ago)
- Topics: curl, hacktoberfest, php
- Language: PHP
- Homepage:
- Size: 3.31 MB
- Stars: 328
- Watchers: 13
- Forks: 120
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php-cn - php-mod/curl - PHP Curl Class (目录 / HTTP客户端 HTTP Client)
README
# PHP Curl Class
This library provides an object-oriented and dependency free wrapper of the PHP cURL extension.
[](https://codeclimate.com/github/php-mod/curl/maintainability)
[](https://codeclimate.com/github/php-mod/curl/test_coverage)
[](//packagist.org/packages/curl/curl)
[](https://github.com/php-mod/curl/actions/workflows/tests.yml)
If you have questions or problems with installation or usage [create an Issue](https://github.com/php-mod/curl/issues).
## Installation
In order to install this library via composer run the following command in the console:
```sh
composer require curl/curl
```
## Usage examples
A few example for using CURL with get:
```php
$curl = (new Curl\Curl())->get('http://www.example.com/');
if ($curl->isSuccess()) {
// do something with response
var_dump($curl->response);
}
// ensure to close the curl connection
$curl->close();
```
Or with params, values will be encoded with `PHP_QUERY_RFC1738`:
```php
$curl = (new Curl\Curl())->get('http://www.example.com/search', [
'q' => 'keyword',
]);
```
An example using post
```php
$curl = new Curl\Curl();
$curl->post('http://www.example.com/login/', [
'username' => 'myusername',
'password' => 'mypassword',
]);
```
An exampling using basic authentication, remove default user agent and working with error handling
```php
$curl = new Curl\Curl();
$curl->setBasicAuthentication('username', 'password');
$curl->setUserAgent('');
$curl->setHeader('X-Requested-With', 'XMLHttpRequest');
$curl->setCookie('key', 'value');
$curl->get('http://www.example.com/');
if ($curl->error) {
echo $curl->error_code;
} else {
echo $curl->response;
}
var_dump($curl->request_headers);
var_dump($curl->response_headers);
```
SSL verification setup:
```php
$curl = new Curl\Curl();
$curl->setOpt(CURLOPT_RETURNTRANSFER, TRUE);
$curl->setOpt(CURLOPT_SSL_VERIFYPEER, FALSE);
$curl->get('https://encrypted.example.com/');
```
Example access to curl object:
```php
curl_set_opt($curl->curl, CURLOPT_USERAGENT, 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1');
curl_close($curl->curl);
```
Example of downloading a file or any other content
```php
$curl = new Curl\Curl();
// open the file where the request response should be written
$file_handle = fopen($target_file, 'w+');
// pass it to the curl resource
$curl->setOpt(CURLOPT_FILE, $file_handle);
// do any type of request
$curl->get('https://github.com');
// disable writing to file
$curl->setOpt(CURLOPT_FILE, null);
// close the file for writing
fclose($file_handle);
```
## Testing
In order to test the library:
1. Create a fork
2. Clone the fork to your machine
3. Install the depencies `composer install`
4. Build and start the docker image (in `tests/server`) `docker build . -t curlserver` start `docker run -p 1234:80 curlserver`
5. Run the unit tests `./vendor/bin/phpunit tests`