https://github.com/peterujah/ob-compress
Php compress Output Buffer In Gzip
https://github.com/peterujah/ob-compress
Last synced: about 1 year ago
JSON representation
Php compress Output Buffer In Gzip
- Host: GitHub
- URL: https://github.com/peterujah/ob-compress
- Owner: peterujah
- License: mit
- Created: 2022-02-23T20:38:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-04T22:42:03.000Z (almost 3 years ago)
- Last Synced: 2025-03-29T18:18:35.327Z (about 1 year ago)
- Language: PHP
- Size: 37.1 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ob-compress
Php OBCompress, compresses the Output Buffer In Gzip
This class can compress the output buffer of a web page or web request.
It can start capturing the output buffer of the current HTTP request and compress using the gzip compression method or none based on specified options. The compressed output will be send with the necessary headers back to user browser and optimized. It can process the responses of requests and output data in JSON, HTML, or plain text format faster than regular request output.
## Installation
Installation is super-easy via Composer:
```md
composer require peterujah/ob-compress
```
To compress webpage output, see the below example code
```php
Text OB Compress
This will be compress and optimized
end();
```
To retrieve data from server it can be done like below
```php
use Peterujah\NanoBlock\OBCompress;
$response = array(
"foo" => "Foo",
"bar" => "Bar"
);
(new OBCompress())->json($response);
```
Available Response methods
Short Hand to compress data and return as json
```php
$compress->json($data);
```
Short Hand to compress data and return as plain text
```php
$compress->text($data);
```
Short Hand to compress data and return as html document
```php
$compress->html($data);
```
Short Hand to compress data and return as specied content type
```php
$compress->run($data, $contentType);
```
Strips and minify a webpage content, start output buffer on webpage, place at the beginning of a webpage
```php
$compress->start();
```
Short Hand to get output buffer of a webpage and compress it then return as spacied data type
```php
$compress->end($contentType);
```
Rrturns compressed output from passed data, sets the status code and data type
```php
$compress->with($data, $statusCode, $contentType);
```
A function to strips and minify a webpage content, this can be passed to `ob_start('OBCompress::minify');`
```php
$compress::minify($content);
```