<!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>Recursively cleanup a working copy directory, finishing incomplete operations and removing locks</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.svn-checkout.html">svn_checkout</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-client-version.html">svn_client_version</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-cleanup" class="refentry">
<div class="refnamediv">
<h1 class="refname">svn_cleanup</h1>
<p class="verinfo">(PECL svn >= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_cleanup</span> — <span class="dc-title">Recursively cleanup a working copy directory, finishing incomplete operations and removing locks</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.svn-cleanup-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>svn_cleanup</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$workingdir</code></span>
)</div>
<p class="para rdfs-comment">
Recursively cleanup working copy directory <em><code class="parameter">workingdir</code></em>,
finishing any incomplete operations and removing working copy locks. Use
when a working copy is in limbo and needs to be usable again.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.svn-cleanup-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">workingdir</code></em></span>
<dd>
<p class="para">
String path to local working directory to cleanup
</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>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.svn-cleanup-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.svn-cleanup-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-cleanup-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4661">
<p><strong>Example #1 Basic example</strong></p>
<div class="example-contents"><p>
This example demonstrates clean up of a working copy in a
directory named help-me:
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />svn_cleanup</span><span style="color: #007700">(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #DD0000">'help-me'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>
The <span class="function"><a href="function.realpath.html" class="function">realpath()</a></span> call is necessary due to
SVN's quirky handling of relative paths.
</p></div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.svn-cleanup-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><strong>update()</strong></span></li>
<li class="member"><a href="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.cleanup.html" class="link external">» SVN documentation on svn cleanup</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-checkout.html">svn_checkout</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-client-version.html">svn_client_version</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>
