PHP 8.4.6 Released!

gzgets

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

gzgetsGet line from file pointer

Description

gzgets(resource $stream, ?int $length = null): string|false

Gets a (uncompressed) string of up to length - 1 bytes read from the given file pointer. Reading ends when length - 1 bytes have been read, on a newline, or on EOF (whichever comes first).

Parameters

stream

The gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().

length

The length of data to get.

Return Values

The uncompressed string, or false on error.

Changelog

Version Description
8.0.0 length is nullable now; previously, the default was 1024.

Examples

Example #1 gzgets() example

<?php
$handle
= gzopen('somefile.gz', 'r');
while (!
gzeof($handle)) {
$buffer = gzgets($handle, 4096);
echo
$buffer;
}
gzclose($handle);
?>

See Also

User Contributed Notes

prismngp1 at yahoo dot com
22 years ago
<?
// this is simple code by VIJAY to unzip .gz file
$file = "/absolute/path/to/your/file" ;
$fp = fopen("$file", "w") ;
// file to be unzipped on your server
$filename = "filename.gz" ;
$zp = gzopen($filename, "r");

if ($zp)
{
while (!gzeof($zp))
{
$buff1 = gzgets ($zp, 4096) ;
fputs($fp, $buff1) ;
}
}
gzclose($zp) ;
fclose($fp) ;
?>
divinity76 at gmail dot com
5 years ago
PS when it encounters and breaks on a newline byte ("\n"), the newline byte itself is not included in the returned string.
Anonymous
19 years ago
For the above example by VIJAY, using gzgetc would be better, as I've encountered binary/text file incompatibilities (at least with PHP 4.0.4).
To Top