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

167 lines
5.1 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: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.realpath" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>realpath</refname>
<refpurpose>Возвращает канонизированный абсолютный путь к файлу</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>realpath</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
<function>realpath</function> раскрывает все символические ссылки,
переходы типа <literal>/./</literal>, <literal>/../</literal> и лишние символы <literal>/</literal> в пути <parameter>path</parameter>,
возвращая канонизированный абсолютный путь к файлу.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Проверяемый путь.
<note>
<para>
Несмотря на то, что путь должен быть указан, переданное
значение может быть пустой строкой. В этих случаях
значение интерпретируется как текущая рабочая директория.
</para>
</note>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
В случае успешного выполнения возвращает канонизированный абсолютный путь.
Результирующий путь не содержит символических ссылок и компонентов
наподобие <literal>/./</literal> или '<literal>/../</literal>.
Разделители <literal>\</literal> и <literal>/</literal> в конце пути также удаляются.
</para>
<para>
<function>realpath</function> возвращает &false; при неудаче, например,
если файл не существует.
</para>
<note>
<para>
Запускаемый скрипт должен иметь права запуска на всех директориях
в проверяемой иерархии, иначе <function>realpath</function> вернёт &false;.
</para>
</note>
<note>
<para>
Для регистронезависимых файловых систем, <function>realpath</function> может
нормализовать или не нормализовать регистр символов.
</para>
</note>
<note>
<para>
Функция <function>realpath</function> не будет работать с
файлом внутри архива Phar, так как путь может быть
не реальным, а виртуальным.
</para>
</note>
<note>
<para>
В Windows переходы и символические ссылки на каталоги расширяются только
на один уровень.
</para>
</note>
&fs.file.32bit;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования функции <function>realpath</function></title>
<programlisting role="php">
<![CDATA[
<?php
chdir('/var/www/');
echo realpath('./../../etc/passwd') . PHP_EOL;
echo realpath('/tmp/') . PHP_EOL;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
/etc/passwd
/tmp
]]>
</screen>
</example>
<example>
<title><function>realpath</function> на Windows</title>
<para>
На Windows <function>realpath</function> изменит пути стиля Unix на
стиль Windows.
</para>
<programlisting role="php">
<![CDATA[
<?php
echo realpath('/windows/system32'), PHP_EOL;
echo realpath('C:\Program Files\\'), PHP_EOL;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
C:\WINDOWS\System32
C:\Program Files
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>basename</function></member>
<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
-->