basename.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 88c1f8d6c9fecf352c5ce152a6f758ed013fc2c0 Maintainer: dallas Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.basename" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>basename</refname>
  <refpurpose>返回路径中的文件名部分</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>
   给出一个包含有指向一个文件的全路径的字符串，本函数返回基本的文件名。
  </para>
     <note>
   <para>
    <function>basename</function> 纯粹基于输入字符串操作，
    它不会受实际文件系统和类似 "<literal>..</literal>" 的路径格式影响。
   </para>
  </note>
  <caution>
   <para>
    <function>basename</function> 是本地化的，所以如果要正确处理多字节字符的路径，需要用
    <function>setlocale</function> 正确设置匹配的 locale。如果 <parameter>path</parameter>
    包含当前区域设置无效的字符，<function>basename</function> 的行为未定义。
   </para>
  </caution>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       一个路径。
      </para>
      <para>
       在 Windows
  中，斜线（<literal>/</literal>）和反斜线（<literal>\</literal>）都可以用作目录分隔符。在其它环境下是斜线（<literal>/</literal>）。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>suffix</parameter></term>
     <listitem>
      <para>
       如果文件名是以
  <parameter>suffix</parameter> 结束的，那这一部分也会被去掉。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回指定 <parameter>path</parameter> 的基本名称。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>basename</function> 例子</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
-->