Files
php-doc-ru/reference/svn/functions/svn-ls.xml
2021-06-08 21:04:42 +03:00

170 lines
5.8 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 715a125af5a86f0e6d6d5aa6cfa9c45257a433ac Maintainer: aur Status: ready -->
<!-- Reviewed: yes Maintainer: lex -->
<!-- $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>Возвращает список содержимого директории репозитория URL, опционально для конкретной ревизии</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>
Данная функция строит запрос по URL адресу репозитория и получает список
файлов и директорий, опционально для конкретной ревизии. Это эквивалентно
команде SVN <userinput>svn list $repos_url[@$revision_no]</userinput>
</para>
<note>
<para>
Данная функция не работает с локальными рабочими копиями репозитория. Параметр
<parameter>repos_url</parameter> <emphasis>должен</emphasis> быть URL-адресом репозитория.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
URL-адрес репозитория, например <userinput>http://www.example.com/svnroot</userinput>.
Для доступа к локальному репозиторию Subversion через файловую систему
используйте файловую URI-схему, например <userinput>file:///home/user/svn-repos</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>revision</parameter></term>
<listitem>
<para>
Целочисленный номер ревизии для получения списка содержимого. Если параметр
опущен, используется последняя ревизия (HEAD).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recurse</parameter></term>
<listitem>
<para>
Включает рекурсивный запрос.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
В случае успеха данная функция возвращает массив имён файлов/директорий в формате:
<screen>
<![CDATA[
[0] => Array
(
[created_rev] => Номер последней ревизии файла/папки
[last_author] => Имя автора последней правки
[size] => Размер файла в байтах
[time] => Дата последнего изменения в формате 'M d H:i'
или 'M d Y', в зависимости от того, сколько прошло времени с последней правки.
[time_t] => отметка времени unix о последнем изменении (целое число)
[name] => имя файла/директории
[type] => тип, может принимать значения 'file' (файл) или 'dir' (директория)
)
[1] => ...
]]>
</screen>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>svn_ls</function></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="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<link xlink:href="&url.svn.manual.list;">SVN-документация по 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
-->