-
Notifications
You must be signed in to change notification settings - Fork 70
/
basename.xml
143 lines (134 loc) · 4.45 KB
/
basename.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?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> наивно работает со входной строкой
и не знает действительную файловую систему или компоненты пути наподобие «..».
</para>
</note>
<caution>
<para>
Функция <function>basename</function> учитывает региональные настройки.
Поэтому, чтобы функция видела правильное базовое имя,
путь которого содержит многобайтовые символы, требуется функцией
<function>setlocale</function> устанавливать
локаль, которая соответствует этим символам.
Функция <function>basename</function> поведёт себя непредсказуемо,
если имя пути <parameter>path</parameter> содержит неправильные
для текущей локали символы.
</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
-->