From 6e83b494132fa55d4c2640e1e19c4fcd6dcd612e Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Thu, 31 Mar 2005 15:01:44 +0000
Subject: [PATCH] Context parameter (bug #32499)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183271 c90b9560-bf6c-de11-be94-00142212c4b1
---
 language-snippets.ent                                | 3 ++-
 reference/filesystem/functions/file-get-contents.xml | 8 +++++++-
 reference/filesystem/functions/file-put-contents.xml | 3 ++-
 reference/filesystem/functions/fopen.xml             | 6 ++----
 reference/filesystem/functions/mkdir.xml             | 6 +++---
 reference/filesystem/functions/readfile.xml          | 3 ++-
 reference/filesystem/functions/rename.xml            | 8 ++------
 reference/filesystem/functions/rmdir.xml             | 8 ++------
 reference/filesystem/functions/unlink.xml            | 8 ++------
 9 files changed, 24 insertions(+), 29 deletions(-)

diff --git a/language-snippets.ent b/language-snippets.ent
index 864577a36a..867bac37f0 100644
--- a/language-snippets.ent
+++ b/language-snippets.ent
@@ -12,7 +12,8 @@ function are cached. See <function>clearstatcache</function> for
 more details.</simpara></note>'>
 
 <!ENTITY note.context-support '<note><simpara>Context support was added
-with PHP 5.0.0.</simpara></note>'>
+with PHP 5.0.0. For a description of <literal>contexts</literal>, refer to
+<xref linkend="ref.stream"/>.</simpara></note>'>
 
 <!ENTITY note.exec-bg '<note><para>If you start a program using this function
 and want to leave it running in the background, you have to make sure that the
diff --git a/reference/filesystem/functions/file-get-contents.xml b/reference/filesystem/functions/file-get-contents.xml
index 879d3de199..baf4a09618 100644
--- a/reference/filesystem/functions/file-get-contents.xml
+++ b/reference/filesystem/functions/file-get-contents.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.22 $ -->
+<!-- $Revision: 1.23 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.130 -->
   <refentry id="function.file-get-contents">
    <refnamediv>
@@ -34,6 +34,11 @@
       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">
@@ -71,6 +76,7 @@
     &reftitle.notes;
     &note.bin-safe;
     &tip.fopen-wrapper;
+    &note.context-support;
     &warn.ssl-non-standard;
    </refsect1>
 
diff --git a/reference/filesystem/functions/file-put-contents.xml b/reference/filesystem/functions/file-put-contents.xml
index 64fff59c65..0e6771da8c 100644
--- a/reference/filesystem/functions/file-put-contents.xml
+++ b/reference/filesystem/functions/file-put-contents.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
   <refentry id="function.file-put-contents">
    <refnamediv>
     <refname>file_put_contents</refname> 
@@ -29,6 +29,7 @@
      (not multi-dimension arrays). This is equivalent to
      <literal>file_put_contents($filename, join('', $array))</literal>.
     </para>
+    &note.context-support;
     <para>
      As of PHP 5.1.0, you may also pass a stream resource to the
      <parameter>data</parameter> parameter. In result, the remaining buffer of
diff --git a/reference/filesystem/functions/fopen.xml b/reference/filesystem/functions/fopen.xml
index 96e2963a3a..5057c1b368 100644
--- a/reference/filesystem/functions/fopen.xml
+++ b/reference/filesystem/functions/fopen.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.26 $ -->
+<!-- $Revision: 1.27 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.fopen">
    <refnamediv>
@@ -49,10 +49,8 @@
       Some protocols (also referred to as <literal>wrappers</literal>) support
       <literal>context</literal> and/or &php.ini; options.
       Refer to the specific page for the protocol in use for a list of options
-      which can be set. ( i.e. &php.ini; value 
+      which can be set. (e.g. &php.ini; value 
       <literal>user_agent</literal> used by the <literal>http</literal> wrapper).
-      For a description of <literal>contexts</literal> and the 
-      <parameter>zcontext</parameter> parameter, refer to <xref linkend="ref.stream"/>.
      </simpara>
     </note>
     &note.context-support;
diff --git a/reference/filesystem/functions/mkdir.xml b/reference/filesystem/functions/mkdir.xml
index f2063e788b..f85328a8a1 100644
--- a/reference/filesystem/functions/mkdir.xml
+++ b/reference/filesystem/functions/mkdir.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.16 $ -->
+<!-- $Revision: 1.17 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.39 -->
   <refentry id="function.mkdir">
    <refnamediv>
@@ -56,10 +56,10 @@ mkdir("/path/to/my/dir", 0700);
       for a listing of which wrappers support <function>mkdir</function>.
      </simpara>
     </note>
+    &note.context-support;
     <note>
      <simpara>
-      The <parameter>recursive</parameter> and <parameter>context</parameter> parameters
-      were added as of PHP 5.0.0.
+      The <parameter>recursive</parameter> parameter was added as of PHP 5.0.0.
      </simpara>
     </note>
     &note.sm.uidcheck.dir;
diff --git a/reference/filesystem/functions/readfile.xml b/reference/filesystem/functions/readfile.xml
index d79409e200..f8392260f0 100644
--- a/reference/filesystem/functions/readfile.xml
+++ b/reference/filesystem/functions/readfile.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.readfile">
    <refnamediv>
@@ -28,6 +28,7 @@
      you want to search for the file in the <link
      linkend="ini.include-path">include_path</link>, too.
     </para>
+    &note.context-support;
     <para>
      See also <function>fpassthru</function>,
      <function>file</function>, <function>fopen</function>,
diff --git a/reference/filesystem/functions/rename.xml b/reference/filesystem/functions/rename.xml
index e16809ab6e..cb2ddc31f2 100644
--- a/reference/filesystem/functions/rename.xml
+++ b/reference/filesystem/functions/rename.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.rename">
    <refnamediv>
@@ -52,11 +52,7 @@ rename("/tmp/tmp_file.txt", "/home/user/login/docs/my_file.txt");
       match the wrapper used in <parameter>newname</parameter>.
      </simpara>
     </note>
-    <note>
-     <simpara>
-      The <parameter>context</parameter> parameter was added as of PHP 5.0.0.
-     </simpara>
-    </note>
+    &note.context-support;
     <para>
      See also <function>copy</function>, 
      <function>unlink</function>, and
diff --git a/reference/filesystem/functions/rmdir.xml b/reference/filesystem/functions/rmdir.xml
index ae1d7a9afc..cca2723f8a 100644
--- a/reference/filesystem/functions/rmdir.xml
+++ b/reference/filesystem/functions/rmdir.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.rmdir">
    <refnamediv>
@@ -25,11 +25,7 @@
       for a listing of which wrappers support <function>rmdir</function>.
      </simpara>
     </note>
-    <note>
-     <simpara>
-      The <parameter>context</parameter> parameter was added as of PHP 5.0.0.
-     </simpara>
-    </note>
+    &note.context-support;
     &note.sm.uidcheck.dir;
     <para>
      See also <function>mkdir</function> and <function>unlink</function>.
diff --git a/reference/filesystem/functions/unlink.xml b/reference/filesystem/functions/unlink.xml
index a646fe9494..b8ddba6a0a 100644
--- a/reference/filesystem/functions/unlink.xml
+++ b/reference/filesystem/functions/unlink.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.unlink">
    <refnamediv>
@@ -24,11 +24,7 @@
       for a listing of which wrappers support <function>unlink</function>.
      </simpara>
     </note>
-    <note>
-     <simpara>
-      The <parameter>context</parameter> parameter was added as of PHP 5.0.0.
-     </simpara>
-    </note>
+    &note.context-support;
     <para>
      See also <function>rmdir</function> for removing directories.
     </para>