<!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><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.svn-log.html">svn_log</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-mkdir.html">svn_mkdir</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-ls" class="refentry">
<div class="refnamediv">
<h1 class="refname">svn_ls</h1>
<p class="verinfo">(PECL svn >= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_ls</span> — <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">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <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"> = false</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$peg</code><span class="initializer"> = false</span></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. <em><code class="parameter">repos_url</code></em>
<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">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">url</code></em></span>
<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>
<dt>
<span class="term"><em><code class="parameter">revision</code></em></span>
<dd>
<p class="para">
Integer revision number to retrieve listing of. When omitted,
the HEAD revision is used.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">recurse</code></em></span>
<dd>
<p class="para">
Enables recursion.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.svn-ls-returnvalues">
<h3 class="title">Return Values</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] => Array
(
[created_rev] => integer revision number of last edit
[last_author] => string author name of last edit
[size] => integer byte file size of file
[time] => string date of last edit in form 'M d H:i'
or 'M d Y', depending on how old the file is
[time_t] => integer unix timestamp of last edit
[name] => name of file/directory
[type] => type, can be 'file' or 'dir'
)
[1] => ...</pre>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.svn-ls-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-ls-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4670">
<p><strong>Example #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"><?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">?></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>
Array
(
[0] => Array
(
[created_rev] => 20
[last_author] => Joe
[size] => 0
[time] => Apr 02 09:28
[time_t] => 1175520529
[name] => tags
[type] => dir
)
[1] => Array
(
[created_rev] => 23
[last_author] => Bob
[size] => 0
[time] => Apr 02 15:15
[time_t] => 1175541322
[name] => trunk
[type] => dir
)
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.svn-ls-seealso">
<h3 class="title">See Also</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">» SVN documentation on svn list</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-log.html">svn_log</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-mkdir.html">svn_mkdir</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>
