Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geerlingguy/request
A simple PHP HTTP request class.
https://github.com/geerlingguy/request
curl library packagist php request
Last synced: 3 months ago
JSON representation
A simple PHP HTTP request class.
- Host: GitHub
- URL: https://github.com/geerlingguy/request
- Owner: geerlingguy
- License: mit
- Created: 2013-09-10T19:19:04.000Z (over 11 years ago)
- Default Branch: 1.x
- Last Pushed: 2021-12-15T19:06:18.000Z (about 3 years ago)
- Last Synced: 2024-10-10T04:06:13.896Z (4 months ago)
- Topics: curl, library, packagist, php, request
- Language: PHP
- Homepage: http://www.midwesternmac.com/request
- Size: 21.5 KB
- Stars: 60
- Watchers: 12
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Request
A simple PHP HTTP request class.
This class includes many convenience methods to help take the headache out of
dealing with HTTP requests in PHP.
## Usage
Include the class (`\JJG\Request`) using an autoloader, then build a new Request
object, execute the request, and get the response.
```php
$request = new Request('http://www.example.com/');
$request->execute();
$response = $request->getResponse();
```
Other parameters you can retrieve after executing a request include:
```php
// The full headers from the response.
$request->getHeader();
// The latency for this response, in ms.
$request->getLatency();
// The HTTP status code (e.g. 200 for 200 OK).
$request->getHttpCode();
// Empty if no error present, otherwise shows any cURL errors.
$request->getError();
```
There are also other convenient methods included for other purposes.
```php
// Returns TRUE if 'string' exists in the response.
$request->checkResponseForContent('string');
```
You can also make requests with basic HTTP authentication:
```php
// Execute a request with HTTP basic authentication.
$request = new Request('http://www.example.com/secure-page');
$request->setBasicAuthCredentials('username', 'password');
$request->execute();
```
Other options include enabling or disabling SSL, using cookies, and setting cURL
timeout values:
```php
// Enable Cookies.
$request->enableCookies($cookie_file_path);
// Enable SSL/TLS.
$request->enableSSL();
// Set the user agent string.
$request->userAgent = 'User agent string here.';
// Set the initial connection timeout (default is 10 seconds).
$request->connectTimeout = 5;
// Set the timeout (default is 15 seconds).
$request->timeout = 10;
// Send some fields as a POST request.
$request->setRequestType('POST');
$request->setPostFields($field_array);
```
See the Request class variable definitions and methods for more
details and documentation.
## Why Request?
I've used other HTTP request libraries for PHP before, but often fall back to
using cURL directly, because the libraries I've used are too complicated for my
needs. This library aims to be a very simple and easy-to-use wrapper around
cURL, and should be easy to pick up for anyone familiar with cURL usage in PHP.
Some other recommended HTTP libraries for PHP include:
- [Guzzle](http://guzzlephp.org/)
- [Httpful](http://phphttpclient.com/)
- [Zend_Http](http://framework.zend.com/manual/1.12/en/zend.http.html)
- [Unirest](https://github.com/mashape/unirest-php)
- [Requests](https://github.com/rmccue/Requests)
## License
Request is licensed under the MIT (Expat) license. See included LICENSE.md.