cvs: phpdoc /en/reference/spl/splfileinfo getbasename.xml getfilename.xml
| From: | Brett Bieber | Date: | Fri, 14 Nov 2008 20:42:06 +0000 |
| Subject: | cvs: phpdoc /en/reference/spl/splfileinfo getbasename.xml getfilename.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2542@lists.php.net to get a copy of this message | ||
saltybeagle Fri Nov 14 20:42:06 2008 UTC
Modified files:
/phpdoc/en/reference/spl/splfileinfo getfilename.xml
getbasename.xml
Log:
Document SplFileInfo::getFilename and make it consistent with getBasename
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/splfileinfo/getfilename.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/spl/splfileinfo/getfilename.xml
diff -u phpdoc/en/reference/spl/splfileinfo/getfilename.xml:1.1
phpdoc/en/reference/spl/splfileinfo/getfilename.xml:1.2
--- phpdoc/en/reference/spl/splfileinfo/getfilename.xml:1.1 Fri Nov 14 18:38:21 2008
+++ phpdoc/en/reference/spl/splfileinfo/getfilename.xml Fri Nov 14 20:42:06 2008
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry xml:id="splfileinfo.getfilename" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileInfo::getFilename</refname>
- <refpurpose>The getFilename purpose</refpurpose>
+ <refpurpose>Get the filename</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>SplFileInfo::getFilename</methodname>
+ <modifier>public</modifier>
<type>string</type><methodname>SplFileInfo::getFilename</methodname>
<void />
</methodsynopsis>
<para>
- The method description goes here.
+ Get the filename without any path information.
</para>
</refsect1>
@@ -26,7 +26,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Description...
+ The filename.
</para>
</refsect1>
@@ -38,14 +38,27 @@
<programlisting role="php">
<![CDATA[
<?php
-/* ... */
+$info = new SplFileInfo('foo.txt');
+var_dump($info->getFilename());
+
+$info = new SplFileInfo('/path/to/foo.txt');
+var_dump($info->getFilename());
+
+$info = new SplFileInfo('http://www.php.net/');
+var_dump($info->getFilename());
+
+$info = new SplFileInfo('http://www.php.net/anoncvs.php');
+var_dump($info->getFilename());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
-...
+string(7) "foo.txt"
+string(7) "foo.txt"
+string(0) ""
+string(11) "anoncvs.php"
]]>
</screen>
</example>
@@ -56,7 +69,7 @@
&reftitle.seealso;
<para>
<simplelist>
- <member><methodname>Classname::Method</methodname></member>
+ <member><methodname>SplFileInfo::getBasename</methodname></member>
</simplelist>
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/splfileinfo/getbasename.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/spl/splfileinfo/getbasename.xml
diff -u phpdoc/en/reference/spl/splfileinfo/getbasename.xml:1.2
phpdoc/en/reference/spl/splfileinfo/getbasename.xml:1.3
--- phpdoc/en/reference/spl/splfileinfo/getbasename.xml:1.2 Fri Nov 14 19:43:01 2008
+++ phpdoc/en/reference/spl/splfileinfo/getbasename.xml Fri Nov 14 20:42:06 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry xml:id="splfileinfo.getbasename" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>SplFileInfo::getBasename</methodname>
+ <modifier>public</modifier>
<type>string</type><methodname>SplFileInfo::getBasename</methodname>
<methodparam
choice="opt"><type>string</type><parameter>suffix</parameter></methodparam>
</methodsynopsis>
<para>
@@ -53,8 +53,10 @@
<?php
$info = new SplFileInfo('file.txt');
var_dump($info->getbaseName());
+
$info = new SplFileInfo('/path/to/file.txt');
var_dump($info->getbaseName());
+
$info = new SplFileInfo('/path/to/file.txt');
var_dump($info->getbaseName('.txt'));
?>
@@ -72,6 +74,15 @@
</para>
</refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><methodname>SplFileInfo::getFilename</methodname></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file