getentries.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: irker Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="rararchive.getentries" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>RarArchive::getEntries</refname>
  <refname>rar_list</refname>
  <refpurpose>Возвращает полный список элементов из RAR архива</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop; (метод):</para>
   <methodsynopsis>
   <modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>RarArchive::getEntries</methodname>
   <void />
   </methodsynopsis>
  <para>&style.procedural;:</para>
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>rar_list</methodname>
   <methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
  </methodsynopsis>
  <para>
   Возвращает элементы (файлы и директории) из RAR архива.
  </para>
  <note>
   <para>
    Если архив имеет элементы с одинаковым именем, то этот метод
    совместно с циклом <literal>foreach</literal> по <type>RarArchive</type>
    и доступом к нему как к массиву с числовыми индексами являются
    единственными способами получить доступ к этим элементам
    (т.е. <methodname>RarArchive::getEntry</methodname> и
    <link linkend="wrappers.rar"><literal>rar://</literal> обработчик
    (wrapper)</link> не помогут).
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>rarfile</parameter></term>
     <listitem>
      <para>
       Объект <type>RarArchive</type> открытый с помощью
       <function>rar_open</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>rar_list</function> возвращает массив объектов <type>RarEntry</type>&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>PECL rar 3.0.0</entry>
       <entry>
        Исправлена поддержка RAR архивов с повторяющимися именами
        элементов.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>&style.oop;</title>
    <programlisting role="php">
<![CDATA[
<?php
$rar_arch = RarArchive::open('solid.rar');
if ($rar_arch === FALSE)
    die("Не смог открыть RAR архив.");

$rar_entries = $rar_arch->getEntries();
if ($rar_entries === FALSE)
    die("Не смог достать содержимое.");

echo "Нашёл " . count($rar_entries) . " объектов.\n";

foreach ($rar_entries as $e) {
    echo $e;
    echo "\n";
}
$rar_arch->close();
?>
]]>
     </programlisting>
     &example.outputs.similar;
     <screen>
<![CDATA[
Нашёл 2 объектов.
RarEntry for file "tese.txt" (23b93a7a)
RarEntry for file "unrardll.txt" (2ed64b6e)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>&style.procedural;</title>
    <programlisting role="php">
<![CDATA[
<?php
$rar_arch = rar_open('solid.rar');
if ($rar_arch === FALSE)
    die("Could not open RAR archive.");

$rar_entries = rar_list($rar_arch);
if ($rar_entries === FALSE)
    die("Could retrieve entries.");

echo "Found " . count($rar_entries) . " entries.\n";

foreach ($rar_entries as $e) {
    echo $e;
    echo "\n";
}
rar_close($rar_arch);
?>
]]>
     </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>RarArchive::getEntry</methodname></member>
    <member><link linkend="wrappers.rar"><literal>rar://</literal> обработчик(wrapper)</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
-->