mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 11:28:55 +00:00
e66e60201a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@188606 c90b9560-bf6c-de11-be94-00142212c4b1
117 lines
3.5 KiB
XML
117 lines
3.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.24 $ -->
|
|
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.130 -->
|
|
<refentry id="function.file-get-contents">
|
|
<refnamediv>
|
|
<refname>file_get_contents</refname>
|
|
<refpurpose>Reads entire file into a string</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>file_get_contents</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
|
|
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Identical to <function>file</function>, except that
|
|
<function>file_get_contents</function> returns the file in a string,
|
|
starting at the specified <parameter>offset</parameter> up to
|
|
<parameter>maxlen</parameter> bytes.
|
|
On failure, <function>file_get_contents</function> will return &false;.
|
|
</para>
|
|
<para>
|
|
<function>file_get_contents</function> is the preferred way to read the
|
|
contents of a file into a string. It will use memory mapping techniques if
|
|
supported by your OS to enhance performance.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
If you're opening a URI with special characters, such as spaces, you
|
|
need to encode the URI with <function>urlencode</function>.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
<parameter>context</parameter> parameter can be skipped by &null;.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.0.0</entry>
|
|
<entry>
|
|
Added the context support.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.1.0</entry>
|
|
<entry>
|
|
Added the <parameter>offset</parameter> and
|
|
<parameter>maxlen</parameter> parameters.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
¬e.bin-safe;
|
|
&tip.fopen-wrapper;
|
|
¬e.context-support;
|
|
&warn.ssl-non-standard;
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>file</function></member>
|
|
<member><function>fgets</function></member>
|
|
<member><function>fread</function></member>
|
|
<member><function>readfile</function></member>
|
|
<member><function>file_put_contents</function></member>
|
|
<member><function>stream_get_contents</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:"../../../../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
|
|
-->
|