PHP: fgets - Manual

Opis

string fgets ( resource uchwyt [, int długość] )

Zwraca łańcuch o długość - 1 bajtów odczytany z pliku wskazanego przez uchwyt. Czytanie kończy się kiedy przeczytano długość - 1 bajtów lub gdy wystąpi znak nowej linii (jest on dołączany do zwracanego wyniku) lub gdy wystąpi znak końca pliku EOF (którykolwiek przypadek zdarzy się pierwszy). Jeśli nie została określona długość, domyślnie przyjmuje 1k (1024 bajty).

W przypadku błędu, zwraca FALSE.

Główna pułapka:

Osoby przyzwyczajone do semantyki 'C' powinni zauważyć różnicę w sposobie zwracania EOF przez fgets().

Wskaźnik na plik musi być poprawny i musi wskazywać na plik pomyślnie otwarty przez funkcję fopen() lub fsockopen().

Prosty przykład:

Przykład 1. Czytanie pliku linia po linii


<?php

$uchwyt = fopen ("/tmp/inputfile.txt", "r");

while (!feof ($uchwyt)) {

    $buffer = fgets($uchwyt, 4096);

    echo $buffer;

}

fclose ($uchwyt);

?>

Notatka: Parametr długość stał się opcjonalny w PHP 4.2.0 jeśli został pominięty, to powinien przyjąć wartość 1024. W PHP 4.3, pominięcie długość powoduje odczytywanie ze strumienia do chwili osiągnięcia końca lini, Jeśli większość lini w pliku jest dłuższa od 8KB, dużo efektywniejsze jest podanie maksymalnej długości linii.

Notatka: Funkcja jest binaarnie bezpieczna od PHP 4.3. Poprzednie wersje nie są binarnie bezpieczne.

Notatka: W przypadku problemów z rozpoznawaniem znaków końca linii przez PHP przy czytaniu plików stworzonych lub znajdujących się na komputerach Macintosh, może pomóc włączenie dyrektywy konfiguracji auto_detect_line_endings.

Patrz także: fread(), fgetc(), stream_get_line(), fopen(), popen(), fsockopen() i socket_set_timeout().

User Contributed Notes


When working with VERY large files, php tends to fall over sideways and die.  



Here is a neat way to pull chunks out of a file very fast and won't stop in mid line, but rater at end of last known line.  It pulled a 30+ million line 900meg file through in ~ 24 seconds.



NOTE: 

$buf just hold current chunk of data to work with.  If you try "$buf .=" (note 'dot' in from of '=') to append $buff, script will come to grinding crawl around 100megs of data, so work with current data then move on!



//File to be opened

$file = "huge.file";

//Open file (DON'T USE a+ pointer will be wrong!)

$fp = fopen($file, 'r');

//Read 16meg chunks

$read = 16777216;

//\n Marker

$part = 0;



while(!feof($fp)) {

    $rbuf = fread($fp, $read);

    for($i=$read;$i > 0 || $n == chr(10);$i--) {

        $n=substr($rbuf, $i, 1);

        if($n == chr(10))break;

        //If we are at the end of the file, just grab the rest and stop loop

        elseif(feof($fp)) {

            $i = $read;

            $buf = substr($rbuf, 0, $i+1);

            break;

        }

    }

    //This is the buffer we want to do stuff with, maybe thow to a function?

    $buf = substr($rbuf, 0, $i+1);

    //Point marker back to last \n point

    $part = ftell($fp)-($read-($i+1));

    fseek($fp, $part);

}

fclose($fp);


Sometimes the strings you want to read from a file are not separated by an end of line character.  the C style getline() function solves this.  Here is my version:

<?php

function getline( $fp, $delim )

{

    $result = "";

    while( !feof( $fp ) )

    {

        $tmp = fgetc( $fp );

        if( $tmp == $delim )

            return $result;

        $result .= $tmp;

    }

    return $result;

}



// Example:

$fp = fopen("/path/to/file.ext", 'r');

while( !feof($fp) )

{

    $str = getline($fp, '|');

    // Do something with $str

}

fclose($fp);

?>


Note that - afaik - fgets reads a line until it reaches a line feed (\\n). Carriage returns (\\r) aren't processed as line endings.

However, nl2br insterts a <br /> tag before carriage returns as well.

This is useful (but not nice - I must admit) when you want to store a more lines in one.

<?php

function write_lines($text) {

  $file = fopen('data.txt', 'a');

  fwrite($file, str_replace("\n", ' ', $text)."\n");

  fclose($file);

}



function read_all() {

  $file = fopen('data.txt', 'r');

  while (!feof($file)) {

    $line = fgets($file);

    echo '<u>Section</u><p>nl2br'.($line).'</p>';

  }

  fclose($file);

}

?>



Try it.


If you need to simulate an un-buffered fgets so that stdin doesnt hang there waiting for some input (i.e. it reads only if there is data available) use this :

<?php



    function fgets_u($pStdn) {



            $pArr = array($pStdn);



        if (false === ($num_changed_streams = stream_select($pArr, $write = NULL, $except = NULL, 0))) {

            print("\$ 001 Socket Error : UNABLE TO WATCH STDIN.\n");

            return FALSE;

        } elseif ($num_changed_streams > 0) {

                return trim(fgets($pStdn, 1024));

        }

            

    }



?>


As a beginner I would have liked to see "how to read a file into a string for use later and not only how to directly echo the fgets() result. This is what I derived:

<?php

 @ $pointer = fopen("$DOCUMENT_ROOT/foo.txt", "r"); // the @ suppresses errors so you have to test the pointer for existence

   if ($pointer) {

      while (!feof($pointer)) {

         $preTEXT = fgets($pointer, 999);

         $TEXT = $TEXT . $preTEXT;

      }

      fclose($pointer);

   }

?>