Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dcarbone/curl-header-extractor
Utility to extract headers from PHP CURL to file request.
https://github.com/dcarbone/curl-header-extractor
composer extract-headers php-curl
Last synced: about 1 month ago
JSON representation
Utility to extract headers from PHP CURL to file request.
- Host: GitHub
- URL: https://github.com/dcarbone/curl-header-extractor
- Owner: dcarbone
- License: mit
- Created: 2016-01-24T17:48:52.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-02-14T17:54:53.000Z (almost 4 years ago)
- Last Synced: 2024-12-14T21:41:51.074Z (about 2 months ago)
- Topics: composer, extract-headers, php-curl
- Language: PHP
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# curl-header-extractor
Utility to extract headers from PHP CURL request.
# Installation
While it is advisable to use [Composer](https://getcomposer.org/), this lib is simple enough to be used without it.
Composer Require entry:
```json
{
"dcarbone/curl-header-extractor": "v3.0.*"
}
```
# Usage
There are 3 methods available:
### [getHeaderAndBody](./src/CURLHeaderExtractor.php#L168)
This method accepts a single argument that may be:
- Full path to the file
- File resource created with [fopen](http://php.net/manual/en/function.fopen.php) with at least read permissions.
- String of response data
The response will be an array with the following structure:
```php
array(
// array of headers,
// string of body content
);
```
#### Example:
```php
list($headers, $body) = \DCarbone\CURLHeaderExtractor::getHeaderAndBody($input);
```
where `$headers` will be an array of headers, or NULL if no headers were found,
and `$body` will be the entire contents of the body.
#### Note:
This method CAN be very expensive to use if you are working with particularly large responses, as the end
result will be the entire contents of the file loaded into memory.
If you wish to extract JUST the headers, the below methods might serve you better.
### [extractHeadersAndBodyStartOffset](./src/CURLHeaderExtractor.php#L81)
This method will return an array with the following structure:
```php
array(
// array of headers,
// integer representing the byte offset of the beginning of the body
);
```
#### Example:
```php
list($headers, $bodyByteOffset) = \DCarbone\CURLHeaderExtractor::extractHeadersAndBodyStartOffset($input);
```
If no headers were seen in the file, `$headers` in the above example will be NULL and the byte offset
will be 0.
### [removeHeadersAndMoveFile](./src/CURLHeaderExtractor.php#L102)
This method will strip the file of the headers, copy the body to a new file, and then delete the old file.
#### Example:
```php
\DCarbone\CURLHeaderExtractor::removeHeadersAndMoveFile($file, 'my_new_filename.ext');
```
If you executed the [extractHeadersAndBodyStartOffset](./src/CURLHeaderExtractor.php#L81) method
already, you may pass in the body start offset integer in as the 3rd argument.
## Invoking
To make this class easier to work with as a "helper", it implements the
[PHP magic method __invoke](http://php.net/manual/en/language.oop5.magic.php#object.invoke) (you
can see the implementation [here](./src/CURLHeaderExtractor.php#L67)).
This allows you to do something like this:
```php
$extractor = new \DCarbone\CURLHeaderExtractor();
list($headers, $body) = $extractor($input);
```
You can, of course, access the other methods as you normally would any static method:
```php
list($headers, $bodyByteOffset) = $extractor::extractHeadersAndBodyStartOffset($input);
```