Changed documentation to reflect that RarArchive::list was renamed RarArchive::getEntries.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@298234 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Gustavo André dos Santos Lopes 2010-04-20 19:57:04 +00:00
parent d1befb8a78
commit ff65144390
7 changed files with 12 additions and 12 deletions

View file

@ -19,7 +19,7 @@ $arch = RarArchive::open("example.rar");
if ($arch === FALSE)
die("Cannot open example.rar");
$entries = $arch->list();
$entries = $arch->getEntries();
if ($entries === FALSE)
die("Cannot retrieve entries");

View file

@ -18,7 +18,7 @@
<para>
Objects of this class can be traversed, yielding the entries stored in the respective RAR archive.
Those entries can also be obtained through <methodname>RarArchive::getEntry</methodname> and
<methodname>RarArchive::list</methodname>.
<methodname>RarArchive::getEntries</methodname>.
</para>
</section>
<!-- }}} -->

View file

@ -64,7 +64,7 @@
<entry>2.0.0</entry>
<entry>
The RAR entries returned by <methodname>RarArchive::getEntry</methodname>
and <methodname>RarArchive::list</methodname> are now invalidated when
and <methodname>RarArchive::getEntries</methodname> are now invalidated when
calling this method. This means that all instance methods called for
such entries and not guaranteed to succeed.
</entry>

View file

@ -1,18 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="rararchive.list" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="rararchive.getentries" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarArchive::list</refname>
<refname>RarArchive::getEntries</refname>
<refname>rar_list</refname>
<refpurpose>Get entries full list from the RAR archive.</refpurpose>
<refpurpose>Get full list of entries from the RAR archive.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>RarArchive::list</methodname>
<modifier>public</modifier> <type>array</type><methodname>RarArchive::getEntries</methodname>
<void />
</methodsynopsis>
<para>Procedural style:</para>
@ -61,7 +61,7 @@ $rar_arch = RarArchive::open('solid.rar');
if ($rar_arch === FALSE)
die("Could not open RAR archive.");
$rar_entries = $rar_arch->list();
$rar_entries = $rar_arch->getEntries();
if ($rar_entries === FALSE)
die("Could retrieve entries.");
@ -127,7 +127,7 @@ sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil

View file

@ -25,7 +25,7 @@
Get entry object (file or directory) from the RAR archive.
</para>
<note>
<para>You can also get entry objects using <methodname>RarArchive::list</methodname>.</para>
<para>You can also get entry objects using <methodname>RarArchive::getEntries</methodname>.</para>
</note>
</refsect1>

View file

@ -82,7 +82,7 @@ $rar_arch = RarArchive::open('encrypted_headers.rar', 'samplepassword');
if ($rar_arch === FALSE)
die("Failed opening file");
$entries = $rar_arch->list();
$entries = $rar_arch->getEntries();
if ($entries === FALSE)
die("Failed fetching entries");

View file

@ -14,7 +14,7 @@
<function name='rar_close' from='PECL rar &gt;= 0.1'/>
<!-- Methods -->
<function name='rararchive::open' from='PECL rar &gt;= 2.0.0'/>
<function name='rararchive::list' from='PECL rar &gt;= 2.0.0'/>
<function name='rararchive::getentries' from='PECL rar &gt;= 2.0.0'/>
<function name='rararchive::getentry' from='PECL rar &gt;= 2.0.0'/>
<function name='rararchive::issolid' from='PECL rar &gt;= 2.0.0'/>
<function name='rararchive::getcomment' from='PECL rar &gt;= 2.0.0'/>