PHP Doku:: Gets line from stream resource up to a given delimiter - function.stream-get-line.html

Verlauf / Chronik / History: (1) anzeigen

Sie sind hier:
Doku-StartseitePHP-HandbuchFunktionsreferenzSonstige GrunderweiterungenStreamsStream Funktionenstream_get_line

Ein Service von Reinhard Neidl - Webprogrammierung.

Stream Funktionen

<<stream_get_filters

stream_get_meta_data>>

stream_get_line

(PHP 5)

stream_get_lineGets line from stream resource up to a given delimiter

Beschreibung

string stream_get_line ( resource $handle , int $length [, string $ending ] )

Gets a line from the given handle.

Reading ends when length bytes have been read, when the string specified by ending is found (which is not included in the return value), or on EOF (whichever comes first).

This function is nearly identical to fgets() except in that it allows end of line delimiters other than the standard \n, \r, and \r\n, and does not return the delimiter itself.

Parameter-Liste

handle

A valid file handle.

length

The number of bytes to read from the handle.

ending

An optional string delimiter.

Rückgabewerte

Returns a string of up to length bytes read from the file pointed to by handle.

If an error occurs, returns FALSE.

Siehe auch

  • fread() - Liest Binärdaten aus einer Datei
  • fgets() - Liest eine Zeile von der Position des Dateizeigers
  • fgetc() - Liest das Zeichen, auf welches der Dateizeiger zeigt

7 BenutzerBeiträge:
- Beiträge aktualisieren...
pk at ritm dot ru
30.11.2009 18:30
fgets is faster but stream_get_line is more useful in a tcp server scripts.

when fgets reads some bytes from socket, where EOF is reached, it returns bool(false) same as stream_get_line

BUT if remote client drops connection, and server script will try to read some data with function fgets, function will return bool(false), and stream_get_line will return string(0) ""

so you can detect remote client disconnection with stream_get_line, and cannot with fgets
bens at effortlessis dot com
20.07.2009 19:36
I've seen posts here and at fgets about stream_get_line() being much faster than fgets. I'm seeing opposite results.

With PHP 5.2.9 (Fedora Core 10) on a dual-core laptop with 2 GB of RAM:

// SCRIPT:
$fp=fopen("php://stdin","r");
// uncomment ONE of the following two lines:
// while($line=stream_get_line($fp,65535,"\n"))
// while ($line = fgets($fp, 65535))
 { 1; }
fclose($fp);

// SHELL PROMPT:
$ time yes "This is a test line" | head -1000000 | php -q SCRIPT

with stream_get_line() enabled, it takes 25 seconds to run. With fgets enabled, it takes 10. I tried it several times and got consistent results within about 1/10 of a second. And stream_get_line() not only doesn't return the limiter (providing no sure way to pass data through including the delimiters) but is also unavailable on PHP4 (which is still commonly used)

So, as far as which is faster, YMMV.
amoo_miki at yahoo dot com
19.08.2008 19:34
If the "ending" is a string, there are cases where the function doesn't return the correct value for the first time it is called. Don't be shocked if you find it returning a string value of upto "length" that includes the "ending". (See bug #44607)

If the "ending" is just a single character, the function would always work correctly. ("\n" is a single character)

Temporarily, until this is fixed, the below function can be used:

<?php
function istream_get_line(&$fp, $length, $end) {
   
$current = ftell($fp);
   
$str = fread($fp, $length);
   
$i = strpos($str, $end);
    if (
$i === FALSE) {
        return
$str;   
    } else {
       
fseek($fp, $current + $i + strlen($end));
        return
substr($str, 0, $i);
    }
}
?>
mail at mdijksman dot nl
15.05.2008 12:32
In addition to dante at lorenso dot com:

I was having problems reading the header of a response with stream_get_line, on the Date: part.

<?php
   
// Sometimes took about 2 minutes
   
while (!feof($fp))                                                                                
    {
       
$line = stream_get_line($fp, 1024, "\n");                                                       
               
        if (
strcmp($line, "\r") == 0)                                                               
        {
            break;
        }       
    }        
   
   
// Always takes less than a second
   
while (!feof($fp))                                                                                
    {
       
$line = fgets($fp, 1024);
               
        if (
strcmp($line, "\r\n") == 0)                                                               
        {
            break;
        }       
    }        
?>

I could find no logic in this, as the stream_get_line sometimes went fast, and sometimes went really slow. In the end I just stopped using stream_get_line and switched to fgets.
Mat Jaggard at Tickets dot com
20.12.2007 17:12
I've spent quite a while trying to get stream_get_line to get a chunk encoded html file and to finish correctly at the end so that I can pipeline requests.

This is the function I have come up with.

<?php
   
function getURLContents($url, $ip, $port, $ssl = false, $closeConnection = false)
    {
        if (
$ssl)
           
$ssl = 'ssl://';
        else
           
$ssl = '';
       
$fp = pfsockopen($ssl.$ip, $port, $errno, $errstr, MAX_TIME_TO_START_CONNECTION);
        if (
$fp)
        {
           
$out 'GET '.$url." HTTP/1.1\r\n";
           
$out .= 'Host: '.$ip.':'.$port."\r\n";
            if (
$closeConnection)
               
$out .= "Connection: close\r\n";
            else
               
$out .= "Connection: keep-alive\r\n";
           
$out .= "\r\n";
            if (!
fwrite($fp, $out))
            {
                echo
'Problem writing to socket, opening a new connection.';
               
fclose($fp);
               
$fp = pfsockopen($ssl.$ip, $port, $errno, $errstr, MAX_TIME_TO_START_CONNECTION);
               
fwrite($fp, $out);
            }
           
$theData = '';
           
$notDone = true;
           
stream_set_blocking($fp, 0);
           
$startTime = time();
           
$lastTime = $startTime;
            while (!
feof($fp) && !$done && (($startTime + MAX_TIME_FOR_THE_RESPONSE) > time()))
            {
               
usleep(100);
               
$theNewData = stream_get_line($fp, 1024, "\n");
               
$theData .= $theNewData;
               
$done = (trim($theNewData) === '0');

            }
        }
        else
        {
            echo
'ERROR CONNECTING TO '.$ip.':'.$port;
            return
false;
        }
        if (
$closeConnection)
           
fclose($fp);
        return
$theData;
    }
?>
dante at lorenso dot com
8.06.2006 21:34
My testing has found this function to be dramatically faster than fgets on PHP 5.1.14.  The difference is probably due to how buffering is used internally.  Compare the following:
<?php
// reads 10,000 lines in 27 seconds
while (!feof($handle)) {
   
$line = fgets($handle, 1000000);
}
?>
vs.
<?php
// reads 10,000 lines in 0.5 seconds
while (!feof($handle)) {
   
$line = stream_get_line($handle, 1000000, "\n");
}
?>

18.04.2006 23:07
In version 5.0.4 using this funtion and then calling ftell($stream) would give you the position up to but not including the "ending" string.

When I rev'd to PHP version 5.1.2, calling this function then using ftell($stream) would give the position up to AND including the "ending" string

for example, parsing HTTP responses.

The response from apache using curl....
------------------------------------------------------------
HTTP/1.1 200 OK
Date: Tue, 18 Apr 2006 20:54:59 GMT
Server: Apache/1.3.33 (Unix) PHP/5.0.4 mod_ssl/2.8.22 OpenSSL/0.9.7e
X-Powered-By: PHP/5.0.4
Transfer-Encoding: chunked
Content-Type: text/html

<html><body>test</body></html>
-------------------------------------------------------------

The code:

<?php

  $headers
= stream_get_line($in,4096,"\r\n\r\n");

  
fseek ($in,ftell($in)+4);

   while (!
feof($in)){
     
fputs ($out,stream_get_line($in,4096,''));
   }

?>

prior to my 5.0.4 this worked perfectly, trimming the \r\n\r\n section of the HTTP response and seperating the top into the $headers string, and the rest was placed into the file handle $out.

using php 5.1.2, the above code chopps off the first 4 bytes of the HTTP response and puts

l><body>test</body></html>

into $out.



PHP Powered Diese Seite bei php.net
The PHP manual text and comments are covered by the Creative Commons Attribution 3.0 License © the PHP Documentation Group - Impressum - mail("TO:Reinhard Neidl",...)