mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
b23296d191
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343794 c90b9560-bf6c-de11-be94-00142212c4b1
101 lines
2.4 KiB
XML
101 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="recursivedirectoryiterator.getsubpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>RecursiveDirectoryIterator::getSubPath</refname>
|
|
<refpurpose>Get sub path</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>string</type><methodname>RecursiveDirectoryIterator::getSubPath</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the sub path relative to the directory given in the constructor.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The sub path.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="recursivedirectoryiterator.getsubpath.example.basic">
|
|
<title><function>getSubPath</function> example</title>
|
|
<para>
|
|
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
$directory = '/tmp';
|
|
|
|
$it = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($directory));
|
|
|
|
foreach ($it as $file) {
|
|
echo 'SubPathName: ' . $it->getSubPathName() . "\n";
|
|
echo 'SubPath: ' . $it->getSubPath() . "\n\n";
|
|
}
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
SubPathName: fruit/apple.xml
|
|
SubPath: fruit
|
|
|
|
SubPathName: stuff.xml
|
|
SubPath:
|
|
|
|
SubPathName: veggies/carrot.xml
|
|
SubPath: veggies
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>RecursiveDirectoryIterator::getSubPathName</methodname></member>
|
|
<member><methodname>RecursiveDirectoryIterator::key</methodname></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|