cvs: phpdoc /en/reference/filesystem/functions chmod.xml file-exists.xml file.xml fread.xml fscanf.xml parse-ini-file.xml pathinfo.xml popen.xml
rename.xml stat.xml touch.xml unlink.xml

derick Mon Jun 16 08:57:32 2003 EDT Modified files: /phpdoc/en/reference/filesystem/functions chmod.xml file-exists.xml file.xml fread.xml fscanf.xml parse-ini-file.xml pathinfo.xml popen.xml rename.xml stat.xml touch.xml unlink.xml Log: - Structural changes

Index: phpdoc/en/reference/filesystem/functions/chmod.xml diff -u phpdoc/en/reference/filesystem/functions/chmod.xml:1.7 phpdoc/en/reference/filesystem/functions/chmod.xml:1.8 --- phpdoc/en/reference/filesystem/functions/chmod.xml:1.7 Thu Jun 12 21:40:03 2003 +++ phpdoc/en/reference/filesystem/functions/chmod.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.chmod"> <refnamediv> @@ -23,6 +23,8 @@ assumed to be an octal value, so strings (such as "g+w") will not work properly. To ensure the expected operation, you need to prefix <parameter>mode</parameter> with a zero (0): + </para> + <para> <informalexample> <programlisting role="php"> <![CDATA[ @@ -45,6 +47,8 @@ writeable, number 4 means that you make the file readable. Add up these numbers to specify needed rights. You can also read more about modes on UNIX systems with 'man 1 chmod' and 'man 2 chmod'. + </para> + <para> <informalexample> <programlisting role="php"> <![CDATA[ @@ -66,17 +70,15 @@ </informalexample> </para> <para> - <note> - <para> - The current user is the user under which PHP runs. It is - probably not the same user you use for normal shell or FTP - access. - </para> - </note> - </para> - <para> &return.success; </para> + <note> + <para> + The current user is the user under which PHP runs. It is + probably not the same user you use for normal shell or FTP + access. + </para> + </note> &note.no-remote; Index: phpdoc/en/reference/filesystem/functions/file-exists.xml diff -u phpdoc/en/reference/filesystem/functions/file-exists.xml:1.9 phpdoc/en/reference/filesystem/functions/file-exists.xml:1.10 --- phpdoc/en/reference/filesystem/functions/file-exists.xml:1.9 Mon Mar 3 06:49:39 2003 +++ phpdoc/en/reference/filesystem/functions/file-exists.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.file-exists"> <refnamediv> @@ -16,14 +16,11 @@ Returns &true; if the file or directory specified by <parameter>filename</parameter> exists; &false; otherwise. </simpara> - <note> - <title>Using Windows shares</title> - <para> - On windows, use <filename>//computername/share/filename</filename> or - <filename>\\computername\share\filename</filename> to check files on - network shares. - </para> - </note> + <para> + On windows, use <filename>//computername/share/filename</filename> or + <filename>\\computername\share\filename</filename> to check files on + network shares. + </para> <para> <example> <title>Testing whether a file exists</title> Index: phpdoc/en/reference/filesystem/functions/file.xml diff -u phpdoc/en/reference/filesystem/functions/file.xml:1.9 phpdoc/en/reference/filesystem/functions/file.xml:1.10 --- phpdoc/en/reference/filesystem/functions/file.xml:1.9 Mon May 19 16:26:58 2003 +++ phpdoc/en/reference/filesystem/functions/file.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.file"> <refnamediv> @@ -21,14 +21,6 @@ newline still attached. Upon failure, <function>file</function> returns &false;. </para> - <note> - <para> - Each line in the resulting array will include the line ending, so you - still need to use <function>trim</function> if you do not want the line - ending present. - </para> - </note> - &note.line-endings; <para> You can use the optional <parameter>use_include_path</parameter> parameter and set it to "1", if you want to search for the file in the <link @@ -55,6 +47,15 @@ </programlisting> </informalexample> </para> + &tip.fopen-wrapper; + <note> + <para> + Each line in the resulting array will include the line ending, so you + still need to use <function>trim</function> if you do not want the line + ending present. + </para> + </note> + &note.line-endings; <note> <para> As of PHP 4.3.0 you can use <function>file_get_contents</function> to @@ -64,7 +65,6 @@ In PHP 4.3.0 <function>file</function> became binary safe. </para> </note> - &tip.fopen-wrapper; <note> <simpara> Context support was added with <literal>PHP 5.0.0</literal> Index: phpdoc/en/reference/filesystem/functions/fread.xml diff -u phpdoc/en/reference/filesystem/functions/fread.xml:1.9 phpdoc/en/reference/filesystem/functions/fread.xml:1.10 --- phpdoc/en/reference/filesystem/functions/fread.xml:1.9 Sun Jun 1 19:11:51 2003 +++ phpdoc/en/reference/filesystem/functions/fread.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.25 --> <refentry id="function.fread"> <refnamediv> @@ -35,13 +35,6 @@ </programlisting> </informalexample> </para> - <note> - <para> - If you just want to get the contents of a file into a string, use - <function>file_get_contents</function> as it has much better performance - than the code above. - </para> - </note> <warning> <para> On systems which differentiate between binary and text files @@ -98,6 +91,13 @@ The example above has better performance than the traditional approach using while(!<function>feof</function>), as we are saving the overhead of a function call per iteration. + </para> + </note> + <note> + <para> + If you just want to get the contents of a file into a string, use + <function>file_get_contents</function> as it has much better performance + than the code above. </para> </note> <simpara> Index: phpdoc/en/reference/filesystem/functions/fscanf.xml diff -u phpdoc/en/reference/filesystem/functions/fscanf.xml:1.8 phpdoc/en/reference/filesystem/functions/fscanf.xml:1.9 --- phpdoc/en/reference/filesystem/functions/fscanf.xml:1.8 Fri May 30 16:43:26 2003 +++ phpdoc/en/reference/filesystem/functions/fscanf.xml Mon Jun 16 08:57:32 2003 @@ -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.fscanf"> <refnamediv> @@ -48,14 +48,14 @@ </example> <example> <title>users.txt</title> - <programlisting> + <screen> <![CDATA[ javier argonaut pe hiroshi sculptor jp robert slacker us luigi florist it ]]> - </programlisting> + </screen> </example> </para> <note> Index: phpdoc/en/reference/filesystem/functions/parse-ini-file.xml diff -u phpdoc/en/reference/filesystem/functions/parse-ini-file.xml:1.12 phpdoc/en/reference/filesystem/functions/parse-ini-file.xml:1.13 --- phpdoc/en/reference/filesystem/functions/parse-ini-file.xml:1.12 Tue Apr 1 18:19:32 2003 +++ phpdoc/en/reference/filesystem/functions/parse-ini-file.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.87 --> <refentry id="function.parse-ini-file"> <refnamediv> @@ -98,12 +98,10 @@ ?> ]]> </programlisting> - </example> - </para> - <para> - Would produce: - <informalexample> - <programlisting> + <para> + Would produce: + </para> + <screen> <![CDATA[ Array ( @@ -130,8 +128,8 @@ ) ]]> - </programlisting> - </informalexample> + </screen> + </example> </para> </refsect1> </refentry> Index: phpdoc/en/reference/filesystem/functions/pathinfo.xml diff -u phpdoc/en/reference/filesystem/functions/pathinfo.xml:1.3 phpdoc/en/reference/filesystem/functions/pathinfo.xml:1.4 --- phpdoc/en/reference/filesystem/functions/pathinfo.xml:1.3 Thu Oct 17 20:39:18 2002 +++ phpdoc/en/reference/filesystem/functions/pathinfo.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.61 --> <refentry id="function.pathinfo"> <refnamediv> @@ -35,19 +35,17 @@ ?> ]]> </programlisting> - </example> - </para> - <para> - Would produce: - <informalexample> - <programlisting> + <para> + Would produce: + </para> + <screen> <![CDATA[ /www/htdocs index.html html ]]> - </programlisting> - </informalexample> + </screen> + </example> </para> <note> <para> Index: phpdoc/en/reference/filesystem/functions/popen.xml diff -u phpdoc/en/reference/filesystem/functions/popen.xml:1.8 phpdoc/en/reference/filesystem/functions/popen.xml:1.9 --- phpdoc/en/reference/filesystem/functions/popen.xml:1.8 Mon Feb 10 15:19:04 2003 +++ phpdoc/en/reference/filesystem/functions/popen.xml Mon Jun 16 08:57:32 2003 @@ -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.popen"> <refnamediv> @@ -46,13 +46,12 @@ </programlisting> </example> </para> - <note> - <para> - If the command to be executed could not be found, a valid - resource is returned. This may seem odd, but makes sense; it - allows you to access any error message returned by the shell: - <informalexample> - <programlisting role="php"> + <para> + If the command to be executed could not be found, a valid + resource is returned. This may seem odd, but makes sense; it + allows you to access any error message returned by the shell: + <informalexample> + <programlisting role="php"> <![CDATA[ <?php error_reporting(E_ALL); @@ -65,10 +64,9 @@ pclose($handle); ?> ]]> - </programlisting> - </informalexample> - </para> - </note> + </programlisting> + </informalexample> + </para> <para> See also <function>pclose</function>, <function>fopen</function>, and <function>proc_open</function>. Index: phpdoc/en/reference/filesystem/functions/rename.xml diff -u phpdoc/en/reference/filesystem/functions/rename.xml:1.5 phpdoc/en/reference/filesystem/functions/rename.xml:1.6 --- phpdoc/en/reference/filesystem/functions/rename.xml:1.5 Fri May 30 20:51:14 2003 +++ phpdoc/en/reference/filesystem/functions/rename.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.rename"> <refnamediv> @@ -33,7 +33,6 @@ </example> </para> <note> - <title>New feature note</title> <para> Prior to PHP 4.3.3, <function>rename</function> could not rename files across partitions on *nix based systems. Index: phpdoc/en/reference/filesystem/functions/stat.xml diff -u phpdoc/en/reference/filesystem/functions/stat.xml:1.7 phpdoc/en/reference/filesystem/functions/stat.xml:1.8 --- phpdoc/en/reference/filesystem/functions/stat.xml:1.7 Sat May 24 16:43:53 2003 +++ phpdoc/en/reference/filesystem/functions/stat.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.stat"> <refnamediv> @@ -30,7 +30,8 @@ returning these attributes in a numeric array, they can be accessed with associative indices, as noted next to each parameter; this is available since PHP 4.0.6: - + </para> + <para> <table> <title><function>stat</function> and <function>fstat</function> result format</title> Index: phpdoc/en/reference/filesystem/functions/touch.xml diff -u phpdoc/en/reference/filesystem/functions/touch.xml:1.6 phpdoc/en/reference/filesystem/functions/touch.xml:1.7 --- phpdoc/en/reference/filesystem/functions/touch.xml:1.6 Thu Jun 12 21:40:03 2003 +++ phpdoc/en/reference/filesystem/functions/touch.xml Mon Jun 16 08:57:32 2003 @@ -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.touch"> <refnamediv> @@ -25,10 +25,9 @@ of parameters. </para> <para> - If the file does not exist, it is created. + If the file does not exist, it is created. &return.success; </para> <para> - &return.success; <example> <title><function>touch</function> example</title> <programlisting role="php"> Index: phpdoc/en/reference/filesystem/functions/unlink.xml diff -u phpdoc/en/reference/filesystem/functions/unlink.xml:1.4 phpdoc/en/reference/filesystem/functions/unlink.xml:1.5 --- phpdoc/en/reference/filesystem/functions/unlink.xml:1.4 Thu Jun 12 21:40:03 2003 +++ phpdoc/en/reference/filesystem/functions/unlink.xml Mon Jun 16 08:57:32 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.unlink"> <refnamediv> @@ -14,10 +14,7 @@ </methodsynopsis> <para> Deletes <parameter>filename</parameter>. Similar to the Unix C - unlink() function. - </para> - <para> - &return.success; + unlink() function. &return.success; </para> <note> <simpara>