php-doc-en/reference/svn/functions/svn-ls.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>
   <methodparam choice="opt"><type>bool</type><parameter>peg</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
-->