Files
php-doc-ru/reference/filesystem/functions/rename.xml
2021-12-23 13:02:26 +03:00

124 lines
3.7 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: ea62fb83196997032641b50fe44420305466195e Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.rename">
<refnamediv>
<refname>rename</refname>
<refpurpose>Переименовывает файл или директорию</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>rename</methodname>
<methodparam><type>string</type><parameter>from</parameter></methodparam>
<methodparam><type>string</type><parameter>to</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Пытается переименовать <parameter>from</parameter> в
<parameter>to</parameter>, перенося файл между директориями, если необходимо.
Если <parameter>to</parameter> существует, то он будет перезаписан. При переименовании
директории с существующим <parameter>to</parameter> будет выведено предупреждение.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>from</parameter></term>
<listitem>
<para>
Старое имя.
</para>
<note>
<para>
Обёртка, используемая в <parameter>from</parameter>
<emphasis>должна</emphasis> совпадать с обёрткой, используемой
в <parameter>to</parameter>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>to</parameter></term>
<listitem>
<para>
Новое имя.
<note>
<simpara>
В Windows, если <parameter>to</parameter> уже существует, он должен быть доступен для записи.
В противном случае <function>rename</function> завершится ошибкой и выдаст <constant>E_WARNING</constant>.
</simpara>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
&note.context-support;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования функции <function>rename</function></title>
<programlisting role="php">
<![CDATA[
<?php
rename("/tmp/tmp_file.txt", "/home/user/login/docs/my_file.txt");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>copy</function></member>
<member><function>unlink</function></member>
<member><function>move_uploaded_file</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
-->