Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/piedweb/curl
[READ-ONLY] PHP curl OOP Wrapper and a bit more
https://github.com/piedweb/curl
api curl http http-client php
Last synced: 4 months ago
JSON representation
[READ-ONLY] PHP curl OOP Wrapper and a bit more
- Host: GitHub
- URL: https://github.com/piedweb/curl
- Owner: PiedWeb
- License: mit
- Created: 2019-01-07T18:48:26.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-02-22T18:13:51.000Z (11 months ago)
- Last Synced: 2024-04-24T03:23:15.754Z (9 months ago)
- Topics: api, curl, http, http-client, php
- Language: PHP
- Homepage: https://dev.piedweb.com/
- Size: 104 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Curl OOP Wrapper
[](https://github.com/PiedWeb/PiedWeb/tags)
[](LICENSE)
[](https://github.com/PiedWeb/PiedWeb/actions)
[](https://scrutinizer-ci.com/g/PiedWeb/PiedWeb)
[](https://codecov.io/gh/PiedWeb/PiedWeb/branch/main)
[](https://shepherd.dev/github/PiedWeb/PiedWeb)
[](https://packagist.org/packages/piedweb/curl)
Simple PHP Curl OOP wrapper for efficient request.
For a more complex or abstracted curl wrapper, use [Guzzle](https://guzzle.readthedocs.io/en/latest/).
## Install
Via [Packagist](https://img.shields.io/packagist/dt/piedweb/curl.svg?style=flat)
```bash
$ composer require piedweb/curl
```
## Usage
Quick Example :
```php
$url = 'https://piedweb.com';
$request = new \PiedWeb\Curl\ExtendedCliend($url);
$request
->setDefaultSpeedOptions(true)
->setDownloadOnlyIf('PiedWeb\Curl\Helper::checkContentType') // 'PiedWeb\Curl\Helper::checkStatusCode'
->setDesktopUserAgent()
;
$result = $request->request();
if ($result instanceof \PiedWeb\Curl\Response) {
$content = $this->getContent();
}
```
Static Wrapper Methods :
```php
use PiedWeb\Curl\StaticClient as Client;
Client::request($url); // @return ?string
Client::get(); // @return PiedWeb\Curl\ExtendedClient
Client::reset()
```
All Other Methods :
```php
$r = new PiedWeb\Curl\ExtendedClient(?string $url);
$r
->setOpt(CURLOPT_*, mixed 'value')
// Preselect Options to avoid eternity wait
->setDefaultGetOptions($connectTimeOut = 5, $timeOut = 10, $dnsCacheTimeOut = 600, $followLocation = true, $maxRedirs = 5)
->setDefaultSpeedOptions() // no header except if setted, 1 redir max, no ssl check
->setNoFollowRedirection()
->setReturnOnlyHeader()
->setCookie(string $cookie)
->setReferer(string $url)
->fakeBrowserHeader(bool $doIt = true)
->setUserAgent(string $ua)
->setDesktopUserAgent()
->setMobileUserAgent()
->setLessJsUserAgent()
->getUserAgent() // @return string
->setDownloadOnlyIf(callable $func) // @param $ContentType can be a String or an Array
->setMaximumResponseSize(int $tooBig = 200000) // @defaut 2Mo
->setDownloadOnly($range = '0-500')
->setPost(array $post)
->setEncodingGzip()
->setProxy(string '[scheme]proxy-host:port[:username:passwrd]') // Scheme, username and passwrd are facultatives. Default Scheme is http://
->setTarget($url)
->getTarget()
$r->request(); // @return true if request succeed else false (see getError)
$response = $r->getResponse(); // @return PiedWeb\Curl\Response or int corresponding to the curl error
$response->getUrl(); // @return string
$response->getContentType(); // @return string
$response->getContent(); // @return string
$response->getHeaders($returnArray = true); // @return array Response Header (or in a string if $returnArray is set to false)
$response->getCookies(); // @return string
$response->getUrl(); // @return string
$response->getError(); // Equivalent to curl function curl_errno
$response->getErrorMessage(); // .. curl_error
use PiedWeb\Curl\ResponseFromCache;
$response = new ResponseFromCache( // same methods than Response except getRequest return null
string $filePathOrContent,
?string $url = null,
array $info = [],
$headers = PHP_EOL.PHP_EOL
);
```
## Contributing
Please see [contributing](https://dev.piedweb.com/contributing)
## Credits
- [PiedWeb](https://piedweb.com)
- [All Contributors](https://github.com/PiedWeb/:package_skake/graphs/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.
