php-doc-en/reference/spl/splfileobject/fpassthru.xml
2009-11-19 14:54:51 +00:00

97 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="splfileobject.fpassthru" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileObject::fpassthru</refname>
<refpurpose>Output all remaining data on a file pointer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>SplFileObject::fpassthru</methodname>
<void />
</methodsynopsis>
<para>
Reads to EOF on the given file pointer from the current position and
writes the results to the output buffer.
</para>
<para>
You may need to call <methodname>SplFileObject::rewind</methodname> to reset the file
pointer to the beginning of the file if you have already written data
to the file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of characters read from <parameter>handle</parameter>
and passed through to the output.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><methodname>SplFileObject::fpassthru</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Open the file in binary mode
$file = new SplFileObject("./img/ok.png", "rb");
// Send the right headers
header("Content-Type: image/png");
header("Content-Length: " . $file->getSize());
// Dump the picture and end script
$file->fpassthru();
exit;
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fpassthru</function></member>
</simplelist>
</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
-->