1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.svn-ls" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>svn_ls</refname>
<refpurpose>Returns list of directory contents in repository URL, optionally at revision number</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>svn_ls</methodname>
<methodparam><type>string</type><parameter>repos_url</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>revision_no</parameter><initializer>SVN_REVISION_HEAD</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recurse</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
This function queries the repository URL and returns a list of
files and directories, optionally from a specific revision. This
is equivalent to <userinput>svn list $repos_url[@$revision_no]</userinput>
</para>
<note>
<para>
This function does not work with working copies. <parameter>repos_url</parameter>
<emphasis>must</emphasis> be a repository URL.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
URL of the repository, eg. <userinput>http://www.example.com/svnroot</userinput>.
To access a local Subversion repository via filesystem, use the
file URI scheme, eg. <userinput>file:///home/user/svn-repos</userinput>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>revision</parameter></term>
<listitem>
<para>
Integer revision number to retrieve listing of. When omitted,
the HEAD revision is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recurse</parameter></term>
<listitem>
<para>
Enables recursion.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
On success, this function returns an array file listing in the format
of:
<screen>
<![CDATA[
[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] => ...
]]>
</screen>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>svn_ls</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
print_r( svn_ls('http://www.example.com/svnroot/') );
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
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
)
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<link xlink:href="&url.svn.manual.list;">SVN documentation on svn list</link>
</member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
