cvs: phpdoc /en/reference/spl/splfileinfo getpath.xml
| From: | Brett Bieber | Date: | Sat, 15 Nov 2008 13:19:17 +0000 |
| Subject: | cvs: phpdoc /en/reference/spl/splfileinfo getpath.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2550@lists.php.net to get a copy of this message | ||
saltybeagle Sat Nov 15 13:19:17 2008 UTC
Modified files:
/phpdoc/en/reference/spl/splfileinfo getpath.xml
Log:
Document SplFileInfo::getPath
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/splfileinfo/getpath.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/spl/splfileinfo/getpath.xml
diff -u phpdoc/en/reference/spl/splfileinfo/getpath.xml:1.1
phpdoc/en/reference/spl/splfileinfo/getpath.xml:1.2
--- phpdoc/en/reference/spl/splfileinfo/getpath.xml:1.1 Fri Nov 14 18:38:21 2008
+++ phpdoc/en/reference/spl/splfileinfo/getpath.xml Sat Nov 15 13:19:17 2008
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry xml:id="splfileinfo.getpath" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileInfo::getPath</refname>
- <refpurpose>The getPath purpose</refpurpose>
+ <refpurpose>Get the path to the file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>SplFileInfo::getPath</methodname>
+ <modifier>public</modifier>
<type>string</type><methodname>SplFileInfo::getPath</methodname>
<void />
</methodsynopsis>
<para>
- The method description goes here.
+ Returns the path to the file, omitting the filename and any trailing slash.
</para>
</refsect1>
@@ -26,7 +26,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Description...
+ Returns the path to the file.
</para>
</refsect1>
@@ -38,14 +38,19 @@
<programlisting role="php">
<![CDATA[
<?php
-/* ... */
-?>
+$info = new SplFileInfo('/usr/bin/php');
+var_dump($info->getPath());
+
+
+$info = new SplFileInfo('/usr/');
+var_dump($info->getPath());?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
-...
+string(8) "/usr/bin"
+string(4) "/usr"
]]>
</screen>
</example>
@@ -56,7 +61,9 @@
&reftitle.seealso;
<para>
<simplelist>
- <member><methodname>Classname::Method</methodname></member>
+ <member><methodname>SplFileInfo::getRealPath</methodname></member>
+ <member><methodname>SplFileInfo::getFilename</methodname></member>
+ <member><methodname>SplFileInfo::getPathInfo</methodname></member>
</simplelist>
</para>
</refsect1>