cvs: /phpdoc/functions filesystem.sgml zlib.sgml

sr Tue Sep 7 05:23:47 1999 EDT Modified files: /phpdoc/functions filesystem.sgml zlib.sgml Log: Added optional use_include_path parameters. Index: phpdoc/functions/filesystem.sgml diff -u phpdoc/functions/filesystem.sgml:1.6 phpdoc/functions/filesystem.sgml:1.7 --- phpdoc/functions/filesystem.sgml:1.6 Wed Aug 25 08:36:16 1999 +++ phpdoc/functions/filesystem.sgml Tue Sep 7 05:23:47 1999 @@ -500,6 +500,7 @@ <funcsynopsis> <funcdef>array <function>file</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> + <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> @@ -507,6 +508,11 @@ returns the file in an array. Each element of the array corresponds to a line in the file, with the newline still attached. + <para> + You can use the optional second parameter and set it to "1", if + you want to search for the file in the <link + linkend="ini.include-path">include_path</link>, too. + <para> See also <function>readfile</function>, <function>fopen</function>, and <function>popen</function>. @@ -797,6 +803,7 @@ <funcdef>int <function>fopen</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> <paramdef>string <parameter>mode</parameter></paramdef> + <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <simpara> If <parameter>filename</parameter> begins with "http://" (not case sensitive), an HTTP @@ -853,6 +860,11 @@ needed, this will be ignored. <para> + You can use the optional third parameter and set it to "1", if + you want to search for the file in the <link + linkend="ini.include-path">include_path</link>, too. + + <para> <example> <title>fopen() example</title> <programlisting> @@ -1394,6 +1406,7 @@ <funcsynopsis> <funcdef>int <function>readfile</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> + <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> Reads a file and writes it to standard output. @@ -1418,6 +1431,10 @@ If <parameter>filename</parameter> begins with neither of these strings, the file will be opened from the filesystem and its contents written to standard output. + <para> + You can use the optional second parameter and set it to "1", if + you want to search for the file in the <link + linkend="ini.include-path">include_path</link>, too. <para> See also <function>fpassthru</function>, <function>file</function>, <function>fopen</function>, <function>include</function>, Index: phpdoc/functions/zlib.sgml diff -u phpdoc/functions/zlib.sgml:1.5 phpdoc/functions/zlib.sgml:1.6 --- phpdoc/functions/zlib.sgml:1.5 Mon Sep 6 05:05:05 1999 +++ phpdoc/functions/zlib.sgml Tue Sep 7 05:23:47 1999 @@ -112,10 +112,16 @@ <funcsynopsis> <funcdef>array <function>gzfile</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> + <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> Identical to <function>readgzfile</function>, except that gzfile() returns the file in an array. + <para> + You can use the optional second parameter and set it to "1", if + you want to search for the file in the <link + linkend="ini.include-path">include_path</link>, too. + <para> See also <function>readgzfile</function>, and <function>gzopen</function>. </refsect1> @@ -215,6 +221,7 @@ <funcdef>int <function>gzopen</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> <paramdef>string <parameter>mode</parameter></paramdef> + <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> Opens a gzip (.gz) file for reading or writing. The mode @@ -237,6 +244,11 @@ <para> If the open fails, the function returns false. + <para> + You can use the optional third parameter and set it to "1", if + you want to search for the file in the <link + linkend="ini.include-path">include_path</link>, too. + <para><example> <title>gzopen() example</title> <programlisting> @@ -470,6 +482,7 @@ <funcsynopsis> <funcdef>int <function>readgzfile</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> + <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> Reads a file, decompresses it and writes it to standard output. @@ -485,6 +498,11 @@ <para> The file <parameter>filename</parameter> will be opened from the filesystem and its contents written to standard output. + + <para> + You can use the optional second parameter and set it to "1", if + you want to search for the file in the <link + linkend="ini.include-path">include_path</link>, too. <para> See also <function>gzpassthru</function>,