<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.svn.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.svn-cleanup.php',
    1 => 'svn_cleanup',
    2 => '作業コピーディレクトリを再帰的にクリーンアップし、中途半端な操作を解消してロックを削除する',
  ),
  'up' => 
  array (
    0 => 'ref.svn.php',
    1 => 'SVN 関数',
  ),
  'prev' => 
  array (
    0 => 'function.svn-checkout.php',
    1 => 'svn_checkout',
  ),
  'next' => 
  array (
    0 => 'function.svn-client-version.php',
    1 => 'svn_client_version',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/svn/functions/svn-cleanup.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.svn-cleanup" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">svn_cleanup</h1>
  <p class="verinfo">(PECL svn &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_cleanup</span> &mdash; <span class="dc-title">作業コピーディレクトリを再帰的にクリーンアップし、中途半端な操作を解消してロックを削除する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.svn-cleanup-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>svn_cleanup</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$workingdir</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   作業コピーディレクトリ <code class="parameter">workingdir</code>
   を再帰的にクリーンアップし、中途半端になっている操作を完了してロックを削除します。
   作業コピーが中途半端な状態になってしまったときに、
   再度使用可能にするために用います。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.svn-cleanup-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">workingdir</code></dt>
    <dd>
     <span class="simpara">
      クリーンアップしたい作業ディレクトリへのパス。
     </span>
     <blockquote class="note"><p><strong class="note">注意</strong>: <span class="simpara">相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び出しもとのスクリプトの作業ディレクトリを基準とするには、<span class="function"><a href="function.realpath.php" class="function">realpath()</a></span> あるいは dirname(__FILE__) を使用してください。</span></p></blockquote>
    </dd>
   
  </dl>

 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.svn-cleanup-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 

 

 <div class="refsect1 examples" id="refsect1-function.svn-cleanup-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 基本的な例</strong></p>
   <div class="example-contents"><p>
    この例は、help-me という作業ディレクトリのクリーンアップを行います。
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>
    SVN における相対パスの扱いは少々変わっているので、
    <span class="function"><a href="function.realpath.php" class="function">realpath()</a></span> のコールは必須です。
   </p></div>
  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-function.svn-cleanup-notes">
  <h3 class="title">注意</h3>
  <div class="warning"><strong class="warning">警告</strong><p class="simpara">この関数は、
<em>実験的</em> なものです。この関数の動作・
名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
のリリースにおいて変更される可能性があります。
この関数は自己責任で使用してください。</p></div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.svn-cleanup-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><strong>update()</strong></span></li>
   <li><a href="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.cleanup.html" class="link external">&raquo;&nbsp;SVN ドキュメントの svn cleanup</a></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>