gzgets

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

gzgetsファイルポインタから 1 行を得る

説明

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

与えられたファイルポインタから最大 length - 1 バイトの文字を読み込み、 これを含む (非圧縮の) 文字列を返します。 length - 1 バイトを読み込むか、改行または EOF になった場合、 (どれかが最初にきた時点で) 読み込みを終了します。

パラメータ

stream

gz ファイルポインタを指定します。 これは有効なファイルポインタであり、かつ、 gzopen() によりオープンできたファイルを指している必要があります。

length

取得するデータ長を指定します。

戻り値

非圧縮の文字列、もしくはエラー時に false

変更履歴

バージョン 説明
8.0.0 length は、nullable になりました。 これより前のバージョンでは、 デフォルトは 1024 でした。

例1 gzgets() の例

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

参考

  • gzopen() - gz ファイルを開く
  • gzgetc() - gz ファイルへのポインタから文字を得る
  • gzwrite() - バイナリセーフな gz ファイル書き込み

関連キーワード:  ポインタ, ファイル, length, gzgets, gz, gzopen, 文字, gzgetc, stream, バージョン