Files
php-doc-ru/reference/svn/functions/svn-commit.xml
Sergey Panteleev daef8df962 Обнуление тега Reviewed (#364)
[skip-lint]
[skip-spellcheck]
2021-11-16 13:03:53 +03:00

195 lines
5.8 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: 715a125af5a86f0e6d6d5aa6cfa9c45257a433ac Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.svn-commit" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>svn_commit</refname>
<refpurpose>Отправляет изменения из рабочей директории в репозиторий</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>svn_commit</methodname>
<methodparam><type>string</type><parameter>log</parameter></methodparam>
<methodparam><type>array</type><parameter>targets</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Отправляет изменения в файлах локальной рабочей копии, перечисленные в массиве
<parameter>targets</parameter> в репозиторий, с сообщением
<parameter>log</parameter>. Директории из массива <parameter>targets</parameter>
будут рекурсивно добавлены, если параметр <parameter>recursive</parameter>
не установлен в &false;.
</para>
<note>
<simpara>
Эта функция не имеет параметров для установки данных аутентификации,
поэтому имя пользователя и пароль должны быть заданы с помощью функции
<function>svn_auth_set_parameter</function>
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>log</parameter></term>
<listitem>
<para>
Строка комментария для текущего изменения.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>targets</parameter></term>
<listitem>
<para>
Массив с путями к локальным файлам или директориям, которые будут отправлены.
</para>
<warning>
<simpara>
Параметр должен быть массивом, строковое значение для добавления
единичного элемента не поддерживается.
</simpara>
</warning>
&svn.relativepath;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recursive</parameter></term>
<listitem>
<para>
Флаг для отключения рекурсивной отправки директорий из
массива <parameter>targets</parameter>.
По умолчанию &true;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает массив в формате:
</para>
<screen>
<![CDATA[
array(
0 => Номер ревизии сделанного изменения
1 => Строка с датой и временем изменения в формате ISO 8601
2 => Имя сделавшего изменения (коммитер)
)
]]>
</screen>
<para>
При неудаче операции возвращается &false;.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Простой пример</title>
<para>
Этот пример отправляет директорию calculator в репозиторий,
используя имя пользователя Bob и пароль abc123 (будем надеяться, что пароль надёжный):
</para>
<programlisting role="php">
<![CDATA[
<?php
svn_auth_set_parameter(SVN_AUTH_PARAM_DEFAULT_USERNAME, 'Bob');
svn_auth_set_parameter(SVN_AUTH_PARAM_DEFAULT_PASSWORD, 'abc123');
var_dump(svn_commit('Комментарий Bob\'а', array(realpath('calculator'))));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(
0 => 1415,
1 => '2007-05-26T01:44:28.453125Z',
2 => 'Bob'
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>svn_auth_set_parameter</function></member>
<member><link xlink:href="&url.svn.manual.commit;">SVN-документация по svn commit</link></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
-->