<?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-ls.php',
    1 => 'svn_ls',
    2 => 'Returns list of directory contents in repository URL, optionally at revision number',
  ),
  'up' => 
  array (
    0 => 'ref.svn.php',
    1 => 'SVN 関数',
  ),
  'prev' => 
  array (
    0 => 'function.svn-log.php',
    1 => 'svn_log',
  ),
  'next' => 
  array (
    0 => 'function.svn-mkdir.php',
    1 => 'svn_mkdir',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/svn/functions/svn-ls.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.svn-ls" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">svn_ls</h1>
  <p class="verinfo">(PECL svn &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_ls</span> &mdash; <span class="dc-title">Returns list of directory contents in repository URL, optionally at revision number</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.svn-ls-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>svn_ls</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$repos_url</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$revision_no</code><span class="initializer"> = SVN_REVISION_HEAD</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$recurse</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$peg</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span><br>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="simpara">
   This function queries the repository URL and returns a list of
   files and directories, optionally from a specific revision. This
   is equivalent to <strong class="userinput"><code>svn list $repos_url[@$revision_no]</code></strong>
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
    This function does not work with working copies. <code class="parameter">repos_url</code>
    <em>must</em> be a repository URL.
   </span>
  </p></blockquote>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.svn-ls-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">url</code></dt>
    <dd>
     <span class="simpara">
      URL of the repository, eg. <strong class="userinput"><code>http://www.example.com/svnroot</code></strong>.
      To access a local Subversion repository via filesystem, use the
      file URI scheme, eg. <strong class="userinput"><code>file:///home/user/svn-repos</code></strong>
     </span>
    </dd>
   
   
    <dt><code class="parameter">revision</code></dt>
    <dd>
     <span class="simpara">
      Integer revision number to retrieve listing of. When omitted,
      the HEAD revision is used.
     </span>
    </dd>
   
   
    <dt><code class="parameter">recurse</code></dt>
    <dd>
     <span class="simpara">
      Enables recursion.
     </span>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.svn-ls-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   On success, this function returns an array file listing in the format
   of:
   <div class="example-contents screen">
<div class="returnvaluescode"><pre class="returnvaluescode">[0] =&gt; Array
    (
        [created_rev] =&gt; integer revision number of last edit
        [last_author] =&gt; string author name of last edit
        [size] =&gt; integer byte file size of file
        [time] =&gt; string date of last edit in form &#039;M d H:i&#039;
                  or &#039;M d Y&#039;, depending on how old the file is
        [time_t] =&gt; integer unix timestamp of last edit
        [name] =&gt; name of file/directory
        [type] =&gt; type, can be &#039;file&#039; or &#039;dir&#039;
    )
[1] =&gt; ...</pre>
</div>
    </div>
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.svn-ls-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 <span class="function"><strong>svn_ls()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />print_r</span><span style="color: #007700">( </span><span style="color: #0000BB">svn_ls</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://www.example.com/svnroot/'</span><span style="color: #007700">) );<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>上の例の出力は、
たとえば以下のようになります。</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [0] =&gt; Array
        (
            [created_rev] =&gt; 20
            [last_author] =&gt; Joe
            [size] =&gt; 0
            [time] =&gt; Apr 02 09:28
            [time_t] =&gt; 1175520529
            [name] =&gt; tags
            [type] =&gt; dir
        )
    [1] =&gt; Array
        (
            [created_rev] =&gt; 23
            [last_author] =&gt; Bob
            [size] =&gt; 0
            [time] =&gt; Apr 02 15:15
            [time_t] =&gt; 1175541322
            [name] =&gt; trunk
            [type] =&gt; dir
        )
)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-function.svn-ls-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-ls-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li>
    <a href="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.list.html" class="link external">&raquo;&nbsp;SVN documentation on svn list</a>
   </li>
  </ul>
 </div>

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