basename.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.basename" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>basename</refname>
  <refpurpose>Returns trailing name component of path</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>basename</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>suffix</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   Given a string containing the path to a file or directory, this function
   will return the trailing name component.
  </para>
  <note>
   <para>
    <function>basename</function> operates naively on the input string,
    and is not aware of the actual filesystem, or path components such
    as "<literal>..</literal>".
   </para>
  </note>
  <caution>
   <para>
    <function>basename</function> is locale aware, so for it to see the 
    correct basename with multibyte character paths, the matching locale must 
    be set using the <function>setlocale</function> function.
    If <parameter>path</parameter> contains characters which are invalid for the
    current locale, the behavior of <function>basename</function> is undefined.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       A path.
      </para>
      <para>
       On Windows, both slash (<literal>/</literal>) and backslash
       (<literal>\</literal>) are used as directory separator character. In
       other environments, it is the forward slash (<literal>/</literal>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>suffix</parameter></term>
     <listitem>
      <para>
       If the name component ends in <parameter>suffix</parameter> this will also
       be cut off.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the base name of the given <parameter>path</parameter>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>basename</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
echo "1) ".basename("/etc/sudoers.d", ".d").PHP_EOL;
echo "2) ".basename("/etc/sudoers.d").PHP_EOL;
echo "3) ".basename("/etc/passwd").PHP_EOL;
echo "4) ".basename("/etc/").PHP_EOL;
echo "5) ".basename(".").PHP_EOL;
echo "6) ".basename("/");
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
1) sudoers
2) sudoers.d
3) passwd
4) etc
5) .
6) 
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>dirname</function></member>
    <member><function>pathinfo</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:"~/.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
-->