SplFileInfo docs

Greetings, I'd like to help contribute to the php manual, and I've started some work documenting various Spl classes – and hope to have a lot more in the future. For the classes that aren't in phpdoc already I ran the skeleton doc generator to just get the basic files. I've prepared this patch for SplFileInfo, to which I've added some examples and explanations to… but I figured I should share this before I got too far. http://paste2.org/p/101476 I hope I'm documenting things correctly, but I'd be happy to make any adjustments if necessary. Thanks for your consideration. -- Brett Bieber

### Eclipse Workspace Patch 1.0 #P phpdoc Index: en/reference/spl/splfileinfo/isexecutable.xml =================================================================== RCS file: en/reference/spl/splfileinfo/isexecutable.xml diff -N en/reference/spl/splfileinfo/isexecutable.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/isexecutable.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.isexecutable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::isExecutable</refname> + <refpurpose>Check if the file is executable</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::isExecutable</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if executable, &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::isExecutable</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$d = new SplFileInfo('/usr/bin/php'); +var_dump($d->isExecutable()); +$d = new SplFileInfo('/usr/bin'); +var_dump($d->isExecutable()); +$d = new SplFileInfo('foo'); +var_dump($d->isExecutable()); +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +bool(true) +bool(true) +bool(false) +]]> + </screen> + </example> + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getctime.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getctime.xml diff -N en/reference/spl/splfileinfo/getctime.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getctime.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getctime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getCTime</refname> + <refpurpose>The getCTime purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getCTime</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getCTime</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/construct.xml =================================================================== RCS file: en/reference/spl/splfileinfo/construct.xml diff -N en/reference/spl/splfileinfo/construct.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/construct.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::__construct</refname> + <refpurpose>Construct a new SplFileInfo object</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <methodname>SplFileInfo::__construct</methodname> + <methodparam><type>string</type><parameter>file_name</parameter></methodparam> + </methodsynopsis> + <para> + Creates a new SplFileInfo object for the file_name specified. The file + does not need to exist, or be readable. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file_name</parameter></term> + <listitem> + <para> + Path to the file. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::__construct</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$info = new SplFileInfo('example.php'); +if ($info->isFile()) { + echo $info->getRealPath(); +} +?> +]]> + </programlisting> + </example> + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getpathname.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getpathname.xml diff -N en/reference/spl/splfileinfo/getpathname.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getpathname.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getpathname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getPathname</refname> + <refpurpose>The getPathname purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getPathname</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getPathname</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getgroup.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getgroup.xml diff -N en/reference/spl/splfileinfo/getgroup.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getgroup.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getgroup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getGroup</refname> + <refpurpose>The getGroup purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getGroup</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getGroup</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getfileinfo.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getfileinfo.xml diff -N en/reference/spl/splfileinfo/getfileinfo.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getfileinfo.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getfileinfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getFileInfo</refname> + <refpurpose>The getFileInfo purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getFileInfo</methodname> + <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>class_name</parameter></term> + <listitem> + <para> + Description... + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getFileInfo</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getfilename.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getfilename.xml diff -N en/reference/spl/splfileinfo/getfilename.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getfilename.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $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> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getFilename</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getFilename</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/islink.xml =================================================================== RCS file: en/reference/spl/splfileinfo/islink.xml diff -N en/reference/spl/splfileinfo/islink.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/islink.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.islink" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::isLink</refname> + <refpurpose>Check if the file is a link</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::isLink</methodname> + <void /> + </methodsynopsis> + <para> + Use this method to check if the file referenced by the SplFileInfo object + is a link. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the file is a link, &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::isLink</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$info = new SplInfo('/path/to/symlink'); +if ($info->isLink()) { + echo 'The real path is '.$info->getRealPath(); +} +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>SplFileInfo::getRealPath</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/setfileclass.xml =================================================================== RCS file: en/reference/spl/splfileinfo/setfileclass.xml diff -N en/reference/spl/splfileinfo/setfileclass.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/setfileclass.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.setfileclass" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::setFileClass</refname> + <refpurpose>Set the class name used with <methodname>SplFileInfo::openFile()</methodname></refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::setFileClass</methodname> + <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> + <para> + Set the class name which SplFileInfo will use to open files with when openFile() is called. + The class name passed to this method must be derived from SplFileObject. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>class_name</parameter></term> + <listitem> + <para> + The class name to be used when openFile() is called. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::setFileClass</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>SplFileInfo::openFile</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/isreadable.xml =================================================================== RCS file: en/reference/spl/splfileinfo/isreadable.xml diff -N en/reference/spl/splfileinfo/isreadable.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/isreadable.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.isreadable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::isReadable</refname> + <refpurpose>Check if file is readable</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::isReadable</methodname> + <void /> + </methodsynopsis> + <para> + Check if the file is readable. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if readable, &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::isReadable</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$d = new SplFileInfo(__FILE__); +var_dump($d->isReadable()); +$d = new SplFileInfo('foo'); +var_dump($d->isReadable()); +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +bool(true) +bool(false) +]]> + </screen> + </example> + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/tostring.xml =================================================================== RCS file: en/reference/spl/splfileinfo/tostring.xml diff -N en/reference/spl/splfileinfo/tostring.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/tostring.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::__toString</refname> + <refpurpose>Returns the path to the file as a string</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::__toString</methodname> + <void /> + </methodsynopsis> + <para> + This method will return the file name of the referenced file. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the path to the file. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::__toString</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$info = SplFileInfo('foo'); +echo $info->__toString().PHP_EOL; +$info = SplFileInfo('/usr/bin/php'); +echo $info->__toString(); +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +foo +/usr/bin/php +]]> + </screen> + </example> + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getrealpath.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getrealpath.xml diff -N en/reference/spl/splfileinfo/getrealpath.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getrealpath.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getrealpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getRealPath</refname> + <refpurpose>The getRealPath purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getRealPath</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getRealPath</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getmtime.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getmtime.xml diff -N en/reference/spl/splfileinfo/getmtime.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getmtime.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getmtime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getMTime</refname> + <refpurpose>The getMTime purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getMTime</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getMTime</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getinode.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getinode.xml diff -N en/reference/spl/splfileinfo/getinode.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getinode.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getinode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getInode</refname> + <refpurpose>The getInode purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getInode</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getInode</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getpathinfo.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getpathinfo.xml diff -N en/reference/spl/splfileinfo/getpathinfo.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getpathinfo.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $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> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getPathInfo</methodname> + <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>class_name</parameter></term> + <listitem> + <para> + Description... + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getPathInfo</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getsize.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getsize.xml diff -N en/reference/spl/splfileinfo/getsize.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getsize.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getSize</refname> + <refpurpose>Get the size of the file</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getSize</methodname> + <void /> + </methodsynopsis> + <para> + Returns the filesize in bytes for the file referenced. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The filesize in bytes. + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + If the file does not exist a RuntimeException will be thrown. + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getSize</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/isdir.xml =================================================================== RCS file: en/reference/spl/splfileinfo/isdir.xml diff -N en/reference/spl/splfileinfo/isdir.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/isdir.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.isdir" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::isDir</refname> + <refpurpose>Check if the file is a directory</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::isDir</methodname> + <void /> + </methodsynopsis> + <para> + This method can be used to determine if the file is a directory. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if a directory, &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::isDir</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$d = new SplFileInfo(dirname(__FILE__)); +var_dump($d->isDir()); + +$d = new SplFileInfo(__FILE__); +var_dump($d->isDir()); +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +bool(true) +bool(false) +]]> + </screen> + </example> + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/isfile.xml =================================================================== RCS file: en/reference/spl/splfileinfo/isfile.xml diff -N en/reference/spl/splfileinfo/isfile.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/isfile.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.isfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::isFile</refname> + <refpurpose>Check if the object references a regular file</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::isFile</methodname> + <void /> + </methodsynopsis> + <para> + Checks if the file referenced by this SplFileInfo object exists and is a regular file. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the file exists and is a regular file (not a link), &false; otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::isFile</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$d = new SplFileInfo(__FILE__); +var_dump($d->isFile()); + +$d = new SplFileInfo(dirname(__FILE__)); +var_dump($d->isFile()); +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +bool(true) +bool(false) +]]> + </screen> + </example> + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getatime.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getatime.xml diff -N en/reference/spl/splfileinfo/getatime.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getatime.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getatime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getATime</refname> + <refpurpose>Get last access time of the file</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getATime</methodname> + <void /> + </methodsynopsis> + <para> + Gets the last access time for the file. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the time the file was last accessed. + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + Throws <methodname>RunTimeException</methodname> on error. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fileatime</function></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:"../../../../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 +--> Index: en/reference/spl/splfileinfo.xml =================================================================== RCS file: en/reference/spl/splfileinfo.xml diff -N en/reference/spl/splfileinfo.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.splfileinfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> + + <title>The SplFileInfo class</title> + <titleabbrev>SplFileInfo</titleabbrev> + + <partintro> + +<!-- {{{ SplFileInfo intro --> + <section xml:id="splfileinfo.intro"> + &reftitle.intro; + <para> + The SplFileInfo class offers a high-level object oriented interface to + information for an individual file. + </para> + </section> +<!-- }}} --> + + <section xml:id="splfileinfo.synopsis"> + &reftitle.classsynopsis; + +<!-- {{{ Synopsis --> + <classsynopsis> + <ooclass><classname>SplFileInfo</classname></ooclass> + +<!-- {{{ Class synopsis --> + <classsynopsisinfo> + <ooclass> + <classname>SplFileInfo</classname> + </ooclass> + </classsynopsisinfo> +<!-- }}} --> + + <classsynopsisinfo role="comment">Methods</classsynopsisinfo> + <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfileinfo')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" /> + </classsynopsis> +<!-- }}} --> + + </section> + + </partintro> + + &reference.spl.entities.splfileinfo; + +</phpdoc:classref> + +<!-- 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:"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 +--> Index: en/reference/spl/splfileinfo/getperms.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getperms.xml diff -N en/reference/spl/splfileinfo/getperms.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getperms.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getperms" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getPerms</refname> + <refpurpose>The getPerms purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getPerms</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getPerms</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getbasename.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getbasename.xml diff -N en/reference/spl/splfileinfo/getbasename.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getbasename.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getbasename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getBasename</refname> + <refpurpose>The getBasename purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getBasename</methodname> + <methodparam choice="opt"><type>string</type><parameter>suffix</parameter></methodparam> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>suffix</parameter></term> + <listitem> + <para> + Description... + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getBasename</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getpath.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getpath.xml diff -N en/reference/spl/splfileinfo/getpath.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getpath.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $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> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getPath</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getPath</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/openfile.xml =================================================================== RCS file: en/reference/spl/splfileinfo/openfile.xml diff -N en/reference/spl/splfileinfo/openfile.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/openfile.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,115 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.openfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::openFile</refname> + <refpurpose>The openFile purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::openFile</methodname> + <methodparam choice="opt"><type>string</type><parameter>open_mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>use_include_path</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>context</parameter></methodparam> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>open_mode</parameter></term> + <listitem> + <para> + Description... + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>use_include_path</parameter></term> + <listitem> + <para> + Description... + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem> + <para> + Description... + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::openFile</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getowner.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getowner.xml diff -N en/reference/spl/splfileinfo/getowner.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getowner.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getowner" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getOwner</refname> + <refpurpose>The getOwner purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getOwner</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getOwner</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/gettype.xml =================================================================== RCS file: en/reference/spl/splfileinfo/gettype.xml diff -N en/reference/spl/splfileinfo/gettype.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/gettype.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.gettype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getType</refname> + <refpurpose>Get the entry's file type.</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getType</methodname> + <void /> + </methodsynopsis> + <para> + Returns the type of the file referenced. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A <type>string</type> representing the type of the entry. + May be one of <literal>file</literal>, <literal>link</literal>, + or <literal>dir</literal> + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + Throws a RuntimeException on error. + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getType</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +$info = new SplFileInfo(__FILE__); +echo $info->getType().PHP_EOL; + +$info = new SplFileInfo(dirname(__FILE__)); +echo $info->getType(); + +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +file +dir +]]> + </screen> + </example> + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/iswritable.xml =================================================================== RCS file: en/reference/spl/splfileinfo/iswritable.xml diff -N en/reference/spl/splfileinfo/iswritable.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/iswritable.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.iswritable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::isWritable</refname> + <refpurpose>Check if the entry is writeable</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::isWritable</methodname> + <void /> + </methodsynopsis> + <para> + Checks if the current entry is writeable. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if writeable, &false; otherwise; + </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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/setinfoclass.xml =================================================================== RCS file: en/reference/spl/splfileinfo/setinfoclass.xml diff -N en/reference/spl/splfileinfo/setinfoclass.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/setinfoclass.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.setinfoclass" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::setInfoClass</refname> + <refpurpose>Set the class used with getFileInfo and getPathInfo</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::setInfoClass</methodname> + <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> + <para> + Use this method to set a custom class which will be used when getFileInfo + and getPathInfo are called. + The class name passed to this method must be derived from SplFileInfo. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>class_name</parameter></term> + <listitem> + <para> + The class name to be used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::setInfoClass</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +--> Index: en/reference/spl/splfileinfo/getlinktarget.xml =================================================================== RCS file: en/reference/spl/splfileinfo/getlinktarget.xml diff -N en/reference/spl/splfileinfo/getlinktarget.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ en/reference/spl/splfileinfo/getlinktarget.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<refentry xml:id="splfileinfo.getlinktarget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SplFileInfo::getLinkTarget</refname> + <refpurpose>The getLinkTarget purpose</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getLinkTarget</methodname> + <void /> + </methodsynopsis> + <para> + The method description goes here. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Description... + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>SplFileInfo::getLinkTarget</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* ... */ +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +... +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><methodname>Classname::Method</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:"../../../../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 +-->