[PHP-DOC] cvs: phpdoc /en/functions filesystem.xml

[Wez Furlong]

wez             Sat Mar 16 12:02:36 2002 EDT

  Modified files:              
    /phpdoc/en/functions        filesystem.xml 
  Log:
  More docs for streams related changes.
  
  
Index: phpdoc/en/functions/filesystem.xml
diff -u phpdoc/en/functions/filesystem.xml:1.129 
phpdoc/en/functions/filesystem.xml:1.130
--- phpdoc/en/functions/filesystem.xml:1.129    Sat Mar 16 10:06:08 2002
+++ phpdoc/en/functions/filesystem.xml  Sat Mar 16 12:02:35 2002
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.129 $ -->
+<!-- $Revision: 1.130 $ -->
  <reference id="ref.filesystem">
   <title>Filesystem functions</title>
   <titleabbrev>Filesystem</titleabbrev>
@@ -233,6 +233,13 @@
       </programlisting>
      </example>
     </para>
+    <note>
+     <para>
+      As of PHP 4.3.0, both <parameter>source</parameter> and
+      <parameter>dest</parameter> may be URLs if the "fopen wrappers"
+      have been enable.  See <function>fopen</function> for more details.
+     </para>
+    </note>
     <warning>
      <para>
       If the destination file already exists, it will be overwritten.
@@ -672,6 +679,27 @@
    </refsect1>
   </refentry>
 
+  <refentry id="function.file-get-contents">
+   <refnamediv>
+    <refname>file_get_contents</refname> 
+    <refpurpose>Reads entire file into a string</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>string</type><methodname>file_get_contents</methodname>
+      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
+      <methodparam 
+choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam>
+     </methodsynopsis>
+    <para> 
+     Identical to <function>readfile</function>, except that
+     <function>file_get_contents</function> returns the file in a string.
+    </para>
+    &note.bin-safe;
+    &tip.fopen-wrapper;
+   </refsect1>
+  </refentry>
+  
   <refentry id="function.file">
    <refnamediv>
     <refname>file</refname> 
@@ -720,6 +748,12 @@
       </programlisting>
      </informalexample>
     </para>
+    <note>
+     <para>
+      As of PHP 4.3.0 you can use <function>file_get_contents</function> to
+      return the contents of a file as a string in a binary safe manner.
+     </para>
+    </note>
     &note.not-bin-safe;
     &tip.fopen-wrapper;
     <para> 
@@ -1184,6 +1218,7 @@
      As of PHP 4.3.0 (not yet released), if you have compiled in
      support for OpenSSL, you may use "https://"; to open an HTTP
      connection over SSL.
+    </simpara>
     <simpara>
      Note that the file pointer allows you to retrieve only the
      <emphasis>body</emphasis> of the response; to retrieve the HTTP