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

[Daniel Beckham]

danbeck         Mon Apr  2 09:43:28 2001 EDT

  Modified files:              
    /phpdoc/en/functions        filesystem.xml 
  Log:
  added docs for pathinfo
  
Index: phpdoc/en/functions/filesystem.xml
diff -u phpdoc/en/functions/filesystem.xml:1.60 phpdoc/en/functions/filesystem.xml:1.61
--- phpdoc/en/functions/filesystem.xml:1.60     Mon Mar 26 15:50:26 2001
+++ phpdoc/en/functions/filesystem.xml  Mon Apr  2 09:43:28 2001
@@ -2100,6 +2100,61 @@
    </refsect1>
   </refentry>
 
+
+  <refentry id="function.pathinfo">
+   <refnamediv>
+    <refname>pathinfo</refname>
+    <refpurpose>Returns information about a file path</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>array <function>pathinfo</function></funcdef>
+      <paramdef>string <parameter>path</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     <function>pathinfo</function> returns an associative array
+     containing information about <parameter>path</parameter>.  The
+     following array elements are returned:
+     <parameter>dirname</parameter>, <parameter>basename</parameter>
+     and <parameter>extension</parameter>.
+    </para>
+    <para>
+     <example>
+      <title><function>pathinfo</function> Example</title>
+      <programlisting role="php">
+&lt;?php
+
+$path_parts = pathinfo("/www/htdocs/index.html");
+
+echo $path_parts["dirname"] . "\n";
+echo $path_parts["basename"] . "\n";
+echo $path_parts["extension"] . "\n";
+
+?&gt;
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     Would produce:
+     <informalexample>
+      <programlisting>
+/www/htdocs
+index.html
+html
+      </programlisting>
+     </informalexample>
+    </para>
+    <para>
+     See also <function>dirname</function>,
+     <function>basename</function> and <function>realpath</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
+
   <refentry id="function.pclose">
    <refnamediv>
     <refname>pclose</refname>