getextension.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="splfileinfo.getextension" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SplFileInfo::getExtension</refname>
  <refpurpose>Gets the file extension</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SplFileInfo">
   <modifier>public</modifier> <type>string</type><methodname>SplFileInfo::getExtension</methodname>
   <void/>
  </methodsynopsis>
  <para>
    Retrieves the file extension.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    Returns a <type>string</type> containing the file extension, or an
    empty <type>string</type> if the file has no extension.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>SplFileInfo::getExtension</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php

$info = new SplFileInfo('foo.txt');
var_dump($info->getExtension());

$info = new SplFileInfo('photo.jpg');
var_dump($info->getExtension());

$info = new SplFileInfo('something.tar.gz');
var_dump($info->getExtension());

?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
string(3) "txt"
string(3) "jpg"
string(2) "gz"
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Another way of getting the extension is to use the 
    <function>pathinfo</function> function.
   </para>
   <informalexample>
    <programlisting role="php">
<![CDATA[
<?php
$extension = pathinfo($info->getFilename(), PATHINFO_EXTENSION);
?>
]]>
    </programlisting>
   </informalexample>
  </note>
 </refsect1> 

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SplFileInfo::getFilename</methodname></member>
   <member><methodname>SplFileInfo::getBasename</methodname></member>
   <member><function>pathinfo</function></member>
  </simplelist>
 </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
-->