<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Sends changes from the local working copy to the repository</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.svn-client-version.html">svn_client_version</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-delete.html">svn_delete</a></div>
<div class="up"><a href="ref.svn.html">SVN Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.svn-commit" class="refentry">
<div class="refnamediv">
<h1 class="refname">svn_commit</h1>
<p class="verinfo">(PECL svn >= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_commit</span> — <span class="dc-title">Sends changes from the local working copy to the repository</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.svn-commit-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>svn_commit</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$log</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$targets</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$recursive</code><span class="initializer"> = true</span></span>
] )</div>
<p class="para rdfs-comment">
Commits changes made in the local working copy files enumerated in
the <em><code class="parameter">targets</code></em> array to the repository, with the
log message <em><code class="parameter">log</code></em>. Directories in the <em><code class="parameter">targets</code></em>
array will be recursively committed unless <em><code class="parameter">recursive</code></em>
is set to <strong><code>FALSE</code></strong>.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
This function does not have any parameters for specifying authentication,
so a username and password must be set using <span class="function"><a href="function.svn-auth-set-parameter.html" class="function">svn_auth_set_parameter()</a></span>
</span>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.svn-commit-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">log</code></em></span>
<dd>
<p class="para">
String log text to commit
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">targets</code></em></span>
<dd>
<p class="para">
Array of local paths of files to be committed
</p>
<div class="warning"><strong class="warning">Warning</strong>
<p class="simpara">
This parameter must be an array, a string for a single
target is not acceptable.
</p>
</div>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">Relative paths will be resolved as if the current working directory was the one that contains the PHP binary. To use the calling script's working directory, use <span class="function"><a href="function.realpath.html" class="function">realpath()</a></span> or dirname(__FILE__).</span></p></blockquote>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">recursive</code></em></span>
<dd>
<p class="para">
Boolean flag to disable recursive committing of
directories in the <em><code class="parameter">targets</code></em> array.
Default is <strong><code>TRUE</code></strong>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.svn-commit-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns array in form of:
</p>
<div class="example-contents screen">
<div class="returnvaluescode"><pre class="returnvaluescode">array(
0 => integer revision number of commit
1 => string ISO 8601 date and time of commit
2 => name of committer
)</pre>
</div>
</div>
<p class="para">
Returns <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.svn-commit-notes">
<h3 class="title">Notes</h3>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
</div>
<div class="refsect1 examples" id="refsect1-function.svn-commit-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4663">
<p><strong>Example #1 Basic example</strong></p>
<div class="example-contents"><p>
This example commits the calculator directory to a repository, using
the username Bob and the password abc123 (hopefully, his password is
stronger):
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />svn_auth_set_parameter</span><span style="color: #007700">(</span><span style="color: #0000BB">SVN_AUTH_PARAM_DEFAULT_USERNAME</span><span style="color: #007700">, </span><span style="color: #DD0000">'Bob'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">svn_auth_set_parameter</span><span style="color: #007700">(</span><span style="color: #0000BB">SVN_AUTH_PARAM_DEFAULT_PASSWORD</span><span style="color: #007700">, </span><span style="color: #DD0000">'abc123'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">svn_commit</span><span style="color: #007700">(</span><span style="color: #DD0000">'Log message of Bob\'s commit'</span><span style="color: #007700">, array(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #DD0000">'calculator'</span><span style="color: #007700">))));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(
0 => 1415,
1 => '2007-05-26T01:44:28.453125Z',
2 => 'Bob'
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.svn-commit-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.svn-auth-set-parameter.html" class="function" rel="rdfs-seeAlso">svn_auth_set_parameter()</a> - Sets an authentication parameter</span></li>
<li class="member"><a href="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.commit.html" class="link external">» SVN documentation on svn commit</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.svn-client-version.html">svn_client_version</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-delete.html">svn_delete</a></div>
<div class="up"><a href="ref.svn.html">SVN Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
