<!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>Update working copy</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.svn-status.html">svn_status</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.tcpwrap.html">TCP</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-update" class="refentry">
<div class="refnamediv">
<h1 class="refname">svn_update</h1>
<p class="verinfo">(PECL svn >= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_update</span> — <span class="dc-title">Update working copy</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.svn-update-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>svn_update</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$revno</code><span class="initializer"> = SVN_REVISION_HEAD</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$recurse</code><span class="initializer"> = true</span></span>
]] )</div>
<p class="para rdfs-comment">
Update working copy at <em><code class="parameter">path</code></em> to revision
<em><code class="parameter">revno</code></em>. If <em><code class="parameter">recurse</code></em> is true,
directories will be recursively updated.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.svn-update-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">path</code></em></span>
<dd>
<p class="para">
Path to local working copy.
</p>
<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">revno</code></em></span>
<dd>
<p class="para">
Revision number to update to, default is <strong><code>SVN_REVISION_HEAD</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">recurse</code></em></span>
<dd>
<p class="para">
Whether or not to recursively update directories.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.svn-update-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns new revision number on success, returns <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.svn-update-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-update-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4672">
<p><strong>Example #1 Basic example</strong></p>
<div class="example-contents"><p>
This example demonstrates basic usage of this function:
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">svn_update</span><span style="color: #007700">(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #DD0000">'working-copy'</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
234
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.svn-update-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.svn-checkout.html" class="function" rel="rdfs-seeAlso">svn_checkout()</a> - Checks out a working copy from the repository</span></li>
<li class="member"> <span class="function"><a href="function.svn-commit.html" class="function" rel="rdfs-seeAlso">svn_commit()</a> - Sends changes from the local working copy to the repository</span></li>
<li class="member"><a href="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.update.html" class="link external">» SVN documentation for svn update</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-status.html">svn_status</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.tcpwrap.html">TCP</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>
