uTools-Manuals/docs/php/svn_ls.html
2019-04-28 19:00:34 +08:00

174 lines
6.3 KiB
HTML

<!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>Returns list of directory contents in repository URL, optionally at revision number</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><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>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$repos_url</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$revision_no</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"> = <strong><code>FALSE</code></strong></span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$peg</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
]]] ) : <span class="type">array</span></div>
<p class="para rdfs-comment">
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">Note</strong>:
<p class="para">
This function does not work with working copies. <code class="parameter">repos_url</code>
<em class="emphasis">must</em> be a repository URL.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.svn-ls-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">url</code></dt>
<dd>
<p class="para">
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>
</p>
</dd>
<dt>
<code class="parameter">revision</code></dt>
<dd>
<p class="para">
Integer revision number to retrieve listing of. When omitted,
the HEAD revision is used.
</p>
</dd>
<dt>
<code class="parameter">recurse</code></dt>
<dd>
<p class="para">
Enables recursion.
</p>
</dd>
</dl>
</p>
</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 notes" id="refsect1-function.svn-ls-notes">
<h3 class="title">注释</h3>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">此函数是<em class="emphasis">实验性</em>的。此函数的表象,包括名称及其相关文档都可能在未来的
PHP 发布版本中未通知就被修改。使用本函数风险自担 。</p></div>
</div>
<div class="refsect1 examples" id="refsect1-function.svn-ls-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-5675">
<p><strong>Example #1 <span class="function"><strong>svn_ls()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />print_r</span><span style="color: #007700">(&nbsp;</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">)&nbsp;);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
<div class="example-contents"><p>以上例程的输出类似于:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
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>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.svn-ls-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member">
<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>
</p>
</div>
</div></div></div></body></html>