New function: stream_get_line()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@122482 c90b9560-bf6c-de11-be94-00142212c4b1

reference/filesystem/functions/fgets.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.fgets">
    <refnamediv>
@@ -71,8 +71,11 @@ fclose ($handle);
     </note>
     &note.line-endings;
     <para> 
-     See also <function>fread</function>, <function>fopen</function>,
-     <function>popen</function>, <function>fgetc</function>,
+     See also <function>fread</function>, 
+     <function>fgetc</function>,
+     <function>stream_get_line</function>,
+     <function>fopen</function>,
+     <function>popen</function>, 
      <function>fsockopen</function>, and
      <function>socket_set_timeout</function>.
     </para>

reference/stream/functions/stream-get-line.xml

@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.stream-get-line">
+   <refnamediv>
+    <refname>stream_get_line</refname>
+    <refpurpose>Gets line from stream resource up to a given delimiter</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>string</type><methodname>stream_get_line</methodname>
+      <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
+      <methodparam><type>int</type><parameter>length</parameter></methodparam>
+      <methodparam><type>string</type><parameter>ending</parameter></methodparam>
+     </methodsynopsis>
+    <para>
+     Returns a string of up to <parameter>length</parameter> bytes read from the file
+     pointed to by <parameter>handle</parameter>. Reading ends when
+     <parameter>length</parameter> bytes have been read, when the string specified by
+     <parameter>ending</parameter> is found (which is <emphasis>not</emphasis>included
+     in the return value), or on EOF (whichever comes first). 
+    </para>
+    <para>
+     If an error occurs, returns &false;.
+    </para>
+    <simpara>
+     This function is nearly identical to <function>fgets</function>
+     except in that it allows end of line delimiters other than the
+     standard \n, \r, and \r\n, and does <emphasis>not</emphasis>
+     return the delimiter itself.
+    </simpara>
+    <para> 
+     See also <function>fread</function>,
+     <function>fgets</function>, and
+     <function>fgetc</function>,
+    </para>
+   </refsect1>
+  </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->