tostring.xml

<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="splfileobject.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SplFileObject::__toString</refname>
  <refpurpose>Returns the current line as a string</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SplFileObject">
   <modifier>public</modifier> <type>string</type><methodname>SplFileObject::__toString</methodname>
   <void/>
  </methodsynopsis>
  <para>
   This method will return the current line as a string.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the current line as a string.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.1.14, 8.2.1</entry>
       <entry>
        Changed from an alias of <methodname>SplFileObject::fgets</methodname>
        to an implementation of <methodname>SplFileObject::current</methodname>
        which returns a CSV string when the
        <constant>SplFileObject::READ_CSV</constant> flag is set.
       </entry>
      </row>
      <row>
       <entry>7.2.19, 7.3.6</entry>
       <entry>
        Changed from an alias of <methodname>SplFileObject::current</methodname> to an alias of <methodname>SplFileObject::fgets</methodname>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </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:"~/.phpdoc/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
-->