Document SplFileInfo::getPathInfo

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269049 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Brett Bieber 2008-11-15 14:08:06 +00:00
parent 19aea2c2b9
commit d10638843f

View file

@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="splfileinfo.getpathinfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileInfo::getPathInfo</refname>
<refpurpose>The getPathInfo purpose</refpurpose>
<refpurpose>Get an SplFileInfo object for the path</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getPathInfo</methodname>
<modifier>public</modifier> <type>SplFileInfo</type><methodname>SplFileInfo::getPathInfo</methodname>
<methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
</methodsynopsis>
<para>
The method description goes here.
Gets an <classname>SplFileInfo</classname> object for the parent of the current file.
</para>
</refsect1>
@ -26,7 +26,7 @@
<term><parameter>class_name</parameter></term>
<listitem>
<para>
Description...
Name of an <classname>SplFileInfo</classname> derived class to use.
</para>
</listitem>
</varlistentry>
@ -38,7 +38,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
Returns an <classname>SplFileInfo</classname> object for the parent path of the file.
</para>
</refsect1>
@ -50,14 +50,16 @@
<programlisting role="php">
<![CDATA[
<?php
/* ... */
$info = new SplFileInfo('/usr/bin/php');
$parent_info = $info->getPathInfo();
var_dump($parent_info->getRealPath());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
string(8) "/usr/bin"
]]>
</screen>
</example>
@ -68,7 +70,7 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
<member><methodname>SplFileInfo::setInfoClass</methodname></member>
</simplelist>
</para>
</refsect1>