php-doc-en/reference/svn/functions/svn-commit.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>Sends changes from the local working copy to the repository</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></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>
   Commits changes made in the local working copy files enumerated in
   the <parameter>targets</parameter> array to the repository, with the
   log message <parameter>log</parameter>. Directories in the <parameter>targets</parameter>
   array will be recursively committed unless <parameter>recursive</parameter>
   is set to &false;.
  </para>
  <note>
   <simpara>
    This function does not have any parameters for specifying authentication,
    so a username and password must be set using <function>svn_auth_set_parameter</function>
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>log</parameter></term>
     <listitem>
      <para>
       String log text to commit
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>targets</parameter></term>
     <listitem>
      <para>
       Array of local paths of files to be committed
      </para>
      <warning>
       <simpara>
        This parameter must be an array, a string for a single
        target is not acceptable.
       </simpara>
      </warning>
      &svn.relativepath;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recursive</parameter></term>
     <listitem>
      <para>
       Boolean flag to disable recursive committing of
       directories in the <parameter>targets</parameter> array.
       Default is &true;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns array in form of:
  </para>
    <screen>
<![CDATA[
array(
    0 => integer revision number of commit
    1 => string ISO 8601 date and time of commit
    2 => name of committer
)
]]>
    </screen>
  <para>
   Returns &false; on failure.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.experimental.func;
 </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>Basic example</title>
    <para>
     This example commits the calculator directory to a repository, using
     the username Bob and the password abc123 (hopefully, his password is
     stronger):
    </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('Log message of Bob\'s commit', 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="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>svn_auth_set_parameter</function></member>
    <member><link xlink:href="&url.svn.manual.commit;">SVN documentation on 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
-->