readgzfile

(PHP 4, PHP 5, PHP 7, PHP 8)

readgzfile — Output a gz-file

Description

readgzfile(string $filename, int $use_include_path = 0): int|false

Reads a file, decompresses it and writes it to standard output.

readgzfile() can be used to read a file which is not in gzip format; in this case readgzfile() will directly read from the file without decompression.

Parameters

filename: The file name. This file will be opened from the filesystem and its contents written to standard output.
use_include_path: You can set this optional parameter to 1, if you want to search for the file in the include_path too.

Return Values

Returns the number of (uncompressed) bytes read from the file on success, or false on failure

Errors/Exceptions

Upon failure, an E_WARNING is emitted.

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

-6

glennh at webadept dot net ¶

21 years ago

This is a rather simple example of usage for this function, but it does work, and it solved a problem I was using with old browsers accessing gzipped files. 

<?PHP 
 
// first we need to stop the server from sending any headers at all.  
ob_start(); 
 
readgzfile("test.html.gz"); // read the file and output directly to
the browser
                                      // non compressed data from the
file
 
ob_end_flush(); // let the headers go//  
 
?> 

There is no need for any html formating if the source file is an HTML formated page, such as the ones I'm using are. Checking the browser version, sends either the gzip file directly, or sends the browser to a page like this, which does the work for it. Well done simple function. 

My server is running PHP 4.2.2 on Linux Redhat version 9 and
Apache 2.0.40