Files
php-doc-ru/reference/filesystem/functions/basename.xml
Sergey Panteleev 6d43fd64d7 Исправление форматирования
[skip-spellcheck]
[skip-lint]
2022-12-27 03:42:36 +03:00

142 lines
4.4 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 88c1f8d6c9fecf352c5ce152a6f758ed013fc2c0 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<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>.
Если <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
-->