[DOC-CVS] [doc-en] master: rar: fix XML to remove useless wrapping para tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-25T15:15:29Z
Commit: https://github.com/php/doc-en/commit/49395299550ff534324a540b902c5480d0b834e4
Raw diff: https://github.com/php/doc-en/commit/49395299550ff534324a540b902c5480d0b834e4.diff
rar: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/rar/examples.xml
M reference/rar/rararchive/close.xml
M reference/rar/rararchive/getcomment.xml
M reference/rar/rararchive/getentries.xml
M reference/rar/rararchive/getentry.xml
M reference/rar/rararchive/isbroken.xml
M reference/rar/rararchive/issolid.xml
M reference/rar/rararchive/open.xml
M reference/rar/rararchive/setallowbroken.xml
M reference/rar/rararchive/tostring.xml
M reference/rar/rarentry/extract.xml
M reference/rar/rarentry/getattr.xml
M reference/rar/rarentry/getcrc.xml
M reference/rar/rarentry/gethostos.xml
M reference/rar/rarentry/getmethod.xml
M reference/rar/rarentry/getname.xml
M reference/rar/rarentry/getpackedsize.xml
M reference/rar/rarentry/getstream.xml
M reference/rar/rarentry/getunpackedsize.xml
M reference/rar/rarentry/getversion.xml
M reference/rar/rarexception/isusingexceptions.xml
M reference/rar/rarexception/setusingexceptions.xml
Diff:
diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml
index 715fb4a24591..a1e58a626833 100644
--- a/reference/rar/examples.xml
+++ b/reference/rar/examples.xml
@@ -1,24 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="rar.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rar.examples">
&reftitle.examples;
-
+
<para>
See also the examples under <link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link>.
</para>
-
- <para>
- <example>
- <title>On-the-fly decompression</title>
- <programlisting role="php">
+
+ <example>
+ <title>On-the-fly decompression</title>
+ <programlisting role="php">
<![CDATA[
<?php
if (!array_key_exists("i", $_GET) || !is_numeric($_GET["i"]))
die("Index unspecified or non-numeric");
$index = (int) $_GET["i"];
-
+
$arch = RarArchive::open("example.rar");
if ($arch === FALSE)
die("Cannot open example.rar");
@@ -47,7 +45,7 @@ $arch->close(); //no longer needed; stream is independent
function detectUserAgent() {
if (!array_key_exists('HTTP_USER_AGENT', $_SERVER))
return "Other";
-
+
$uas = $_SERVER['HTTP_USER_AGENT'];
if (preg_match("@Opera/@", $uas))
return "Opera";
@@ -59,7 +57,7 @@ function detectUserAgent() {
if (((float) $matches[1]) >= 7.0)
return "IE";
}
-
+
return "Other";
}
@@ -105,27 +103,25 @@ header("Content-Length: $filesize");
if ($_SERVER['REQUEST_METHOD'] == "HEAD")
die();
-
+
while (!feof($fp)) {
$s = @fread($fp, 8192);
if ($s === false)
break; //useless to send error messages
-
+
echo $s;
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example opens a RAR file and presents the requested file inside the RAR archive for download to the client.
</para>
-
- <para>
- <example>
- <title>RAR extension filesystem extraction example</title>
- <programlisting role="php">
+
+ <example>
+ <title>RAR extension filesystem extraction example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -145,16 +141,14 @@ rar_close($rar_file);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example opens a RAR file archive and extracts each entry to the
specified directory.
</para>
-
-</chapter>
+</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -175,4 +169,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/rar/rararchive/close.xml b/reference/rar/rararchive/close.xml
index 725e6e93e234..5b5873b7d63d 100644
--- a/reference/rar/rararchive/close.xml
+++ b/reference/rar/rararchive/close.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.close">
<refnamediv>
<refname>RarArchive::close</refname>
<refname>rar_close</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarArchive::close</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -27,18 +26,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>rarfile</parameter></term>
- <listitem>
- <para>
- A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rarfile</parameter></term>
+ <listitem>
+ <para>
+ A <type>RarArchive</type> object, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -47,40 +44,37 @@
&return.success;
</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 2.0.0</entry>
- <entry>
- The RAR entries returned by <methodname>RarArchive::getEntry</methodname>
- 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>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL rar 2.0.0</entry>
+ <entry>
+ The RAR entries returned by <methodname>RarArchive::getEntry</methodname>
+ 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>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = RarArchive::open('latest_winrar.rar');
@@ -89,20 +83,18 @@ $rar_arch->close();
echo $rar_arch."\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar"
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar" (closed)
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = rar_open('latest_winrar.rar');
@@ -111,14 +103,12 @@ rar_close($rar_arch);
echo $rar_arch."\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/getcomment.xml b/reference/rar/rararchive/getcomment.xml
index d00220d54a8d..f4334ddbf89a 100644
--- a/reference/rar/rararchive/getcomment.xml
+++ b/reference/rar/rararchive/getcomment.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.getcomment" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.getcomment">
<refnamediv>
<refname>RarArchive::getComment</refname>
<refname>rar_comment_get</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>RarArchive::getComment</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -32,18 +31,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>rarfile</parameter></term>
- <listitem>
- <para>
- A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rarfile</parameter></term>
+ <listitem>
+ <para>
+ A <type>RarArchive</type> object, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,43 +59,38 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
-$rar_arch = RarArchive::open('commented.rar');
+$rar_arch = RarArchive::open('commented.rar');
echo $rar_arch->getComment();
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
This is the comment of the file commented.rar.
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
-$rar_arch = rar_open('commented.rar');
+$rar_arch = rar_open('commented.rar');
echo rar_comment_get($rar_arch);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/getentries.xml b/reference/rar/rararchive/getentries.xml
index ef7f9869af36..c1419eddba66 100644
--- a/reference/rar/rararchive/getentries.xml
+++ b/reference/rar/rararchive/getentries.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.getentries" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.getentries">
<refnamediv>
<refname>RarArchive::getEntries</refname>
<refname>rar_list</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>RarArchive::getEntries</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -37,18 +36,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>rarfile</parameter></term>
- <listitem>
- <para>
- A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rarfile</parameter></term>
+ <listitem>
+ <para>
+ A <type>RarArchive</type> object, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -58,37 +55,34 @@
&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>
- Support for RAR archives with repeated entry names is no longer defective.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </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>
+ Support for RAR archives with repeated entry names is no longer defective.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = RarArchive::open('solid.rar');
@@ -108,21 +102,19 @@ foreach ($rar_entries as $e) {
$rar_arch->close();
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Found 2 entries.
RarEntry for file "tese.txt" (23b93a7a)
RarEntry for file "unrardll.txt" (2ed64b6e)
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = rar_open('solid.rar');
@@ -142,23 +134,19 @@ foreach ($rar_entries as $e) {
rar_close($rar_arch);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</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>
+ <simplelist>
+ <member><methodname>RarArchive::getEntry</methodname></member>
+ <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/getentry.xml b/reference/rar/rararchive/getentry.xml
index 2cc6f7df2315..66ef4350cd71 100644
--- a/reference/rar/rararchive/getentry.xml
+++ b/reference/rar/rararchive/getentry.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.getentry" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.getentry">
<refnamediv>
<refname>RarArchive::getEntry</refname>
<refname>rar_entry_get</refname>
@@ -33,30 +32,28 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>rarfile</parameter></term>
- <listitem>
- <para>
- A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>entryname</parameter></term>
- <listitem>
- <para>
- Path to the entry within the RAR archive.
- </para>
- <note>
- <para>The path must be the same returned by
- <methodname>RarEntry::getName</methodname>.</para>
- </note>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rarfile</parameter></term>
+ <listitem>
+ <para>
+ A <type>RarArchive</type> object, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>entryname</parameter></term>
+ <listitem>
+ <para>
+ Path to the entry within the RAR archive.
+ </para>
+ <note>
+ <para>The path must be the same returned by
+ <methodname>RarEntry::getName</methodname>.</para>
+ </note>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -68,10 +65,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = RarArchive::open('solid.rar');
@@ -85,20 +81,18 @@ echo $rar_entry;
$rar_arch->close();
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
RarEntry
RarEntry for file "tese.txt" (23b93a7a)
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = rar_open('solid.rar');
@@ -112,23 +106,19 @@ echo $rar_entry;
rar_close($rar_arch);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarArchive::getEntries</methodname></member>
- <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarArchive::getEntries</methodname></member>
+ <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/isbroken.xml b/reference/rar/rararchive/isbroken.xml
index f6a193352db0..db2aa988767c 100644
--- a/reference/rar/rararchive/isbroken.xml
+++ b/reference/rar/rararchive/isbroken.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.isbroken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.isbroken">
<refnamediv>
<refname>RarArchive::isBroken</refname>
<refname>rar_broken_is</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarArchive::isBroken</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -27,18 +26,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>rarfile</parameter></term>
- <listitem>
- <para>
- A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rarfile</parameter></term>
+ <listitem>
+ <para>
+ A <type>RarArchive</type> object, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,10 +51,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
function retnull() { return null; }
@@ -67,19 +63,17 @@ $arch = RarArchive::open($file, null, 'retnull');
var_dump($arch->isBroken());
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(true)
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
function retnull() { return null; }
@@ -89,22 +83,18 @@ $arch = rar_open($file, null, 'retnull');
var_dump(rar_broken_is($arch));
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarArchive::setAllowBroken</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarArchive::setAllowBroken</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/issolid.xml b/reference/rar/rararchive/issolid.xml
index c6a7b292df70..5ad24fc7b76c 100644
--- a/reference/rar/rararchive/issolid.xml
+++ b/reference/rar/rararchive/issolid.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.issolid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.issolid">
<refnamediv>
<refname>RarArchive::isSolid</refname>
<refname>rar_solid_is</refname>
@@ -13,7 +12,7 @@
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarArchive::isSolid</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
@@ -23,23 +22,21 @@
<para>
Check whether the RAR archive is solid. Individual file extraction is slower on solid
archives.
- </para>
+ </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>rarfile</parameter></term>
- <listitem>
- <para>
- A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rarfile</parameter></term>
+ <listitem>
+ <para>
+ A <type>RarArchive</type> object, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -51,10 +48,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$arch1 = RarArchive::open("store_method.rar");
@@ -63,20 +59,18 @@ echo "$arch1: " . ($arch1->isSolid()?'yes':'no') ."\n";
echo "$arch2: " . ($arch2->isSolid()?'yes':'no') . "\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
RAR Archive "C:\php_rar\trunk\tests\store_method.rar": no
RAR Archive "C:\php_rar\trunk\tests\solid.rar": yes
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$arch1 = rar_open("store_method.rar");
@@ -85,13 +79,11 @@ echo "$arch1: " . (rar_solid_is($arch1)?'yes':'no') ."\n";
echo "$arch2: " . (rar_solid_is($arch2)?'yes':'no') . "\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/open.xml b/reference/rar/rararchive/open.xml
index 2c94c9fe76f1..e5e005d10805 100644
--- a/reference/rar/rararchive/open.xml
+++ b/reference/rar/rararchive/open.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.open">
<refnamediv>
<refname>RarArchive::open</refname>
<refname>rar_open</refname>
@@ -37,45 +36,43 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- Path to the Rar archive.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>password</parameter></term>
- <listitem>
- <para>
- A plain password, if needed to decrypt the headers. It will also be used by default
- if encrypted files are found. Note that the files may have
- different passwords in respect to the headers and among them.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>volume_callback</parameter></term>
- <listitem>
- <para>
- A function that receives one parameter – the path of the volume
- that was not found – and returns a string with the correct path
- for such volume or &null; if such volume does
- not exist or is not known. The programmer should ensure the
- passed function doesn't cause loops as this function is called
- repeatedly if the path returned in a previous call did not
- correspond to the needed volume. Specifying this parameter omits
- the notice that would otherwise be emitted whenever a volume is
- not found; an implementation that only returns &null;
- can therefore be used to merely omit such notices.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the Rar archive.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>password</parameter></term>
+ <listitem>
+ <para>
+ A plain password, if needed to decrypt the headers. It will also be used by default
+ if encrypted files are found. Note that the files may have
+ different passwords in respect to the headers and among them.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>volume_callback</parameter></term>
+ <listitem>
+ <para>
+ A function that receives one parameter – the path of the volume
+ that was not found – and returns a string with the correct path
+ for such volume or &null; if such volume does
+ not exist or is not known. The programmer should ensure the
+ passed function doesn't cause loops as this function is called
+ repeatedly if the path returned in a previous call did not
+ correspond to the needed volume. Specifying this parameter omits
+ the notice that would otherwise be emitted whenever a volume is
+ not found; an implementation that only returns &null;
+ can therefore be used to merely omit such notices.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<warning>
<para>
Prior to version 2.0.0, this function would not handle relative
@@ -93,40 +90,37 @@
<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>
- <parameter>volume_callback</parameter> was added.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </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>
+ <parameter>volume_callback</parameter> was added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = RarArchive::open('encrypted_headers.rar', 'samplepassword');
if ($rar_arch === FALSE)
die("Failed opening file");
-
+
$entries = $rar_arch->getEntries();
if ($entries === FALSE)
die("Failed fetching entries");
@@ -135,7 +129,7 @@ echo "Found " . count($entries) . " files.\n";
if (empty($entries))
die("No valid entries found.");
-
+
$stream = reset($entries)->getStream();
if ($stream === FALSE)
die("Failed opening first file");
@@ -148,27 +142,25 @@ echo stream_get_contents($stream);
fclose($stream);
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Found 2 files.
Content of first one follows:
Encrypted file 1 contents.
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = rar_open('encrypted_headers.rar', 'samplepassword');
if ($rar_arch === FALSE)
die("Failed opening file");
-
+
$entries = rar_list($rar_arch);
if ($entries === FALSE)
die("Failed fetching entries");
@@ -177,7 +169,7 @@ echo "Found " . count($entries) . " files.\n";
if (empty($entries))
die("No valid entries found.");
-
+
$stream = reset($entries)->getStream();
if ($stream === FALSE)
die("Failed opening first file");
@@ -190,13 +182,11 @@ echo stream_get_contents($stream);
fclose($stream);
?>
]]>
- </programlisting>
- </example>
- </para>
- <para>
- <example>
- <title>Volume Callback</title>
- <programlisting role="php">
+ </programlisting>
+ </example>
+ <example>
+ <title>Volume Callback</title>
+ <programlisting role="php">
<![CDATA[
<?php
/* In this example, there's a volume named multi_broken.part1.rar
@@ -212,23 +202,19 @@ $entry = $rar_file1->getEntry('file2.txt');
$entry->extract(null, dirname(__FILE__) . "/temp_file2.txt");
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/setallowbroken.xml b/reference/rar/rararchive/setallowbroken.xml
index 31fdbcf5e1d5..5bef5278e4c3 100644
--- a/reference/rar/rararchive/setallowbroken.xml
+++ b/reference/rar/rararchive/setallowbroken.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.setallowbroken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.setallowbroken">
<refnamediv>
<refname>RarArchive::setAllowBroken</refname>
<refpurpose>Whether opening broken archives is allowed</refpurpose>
@@ -30,26 +29,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>rarfile</parameter></term>
- <listitem>
- <para>
- A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>allow_broken</parameter></term>
- <listitem>
- <para>
- Whether to allow reading broken files (&true;) or not (&false;).
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rarfile</parameter></term>
+ <listitem>
+ <para>
+ A <type>RarArchive</type> object, opened with <function>rar_open</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>allow_broken</parameter></term>
+ <listitem>
+ <para>
+ Whether to allow reading broken files (&true;) or not (&false;).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -59,13 +56,12 @@
already been closed.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>&style.oop;</title>
- <programlisting role="php">
+ <example>
+ <title>&style.oop;</title>
+ <programlisting role="php">
<![CDATA[
<?php
function retnull() { return null; }
@@ -79,20 +75,18 @@ foreach ($a->getEntries() as $e) {
var_dump(count($a));
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
RarEntry for file "file1.txt" (52b28202)
int(1)
]]>
- </screen>
- </example>
- </para>
- <para>
- <example>
- <title>&style.procedural;</title>
- <programlisting role="php">
+ </screen>
+ </example>
+ <example>
+ <title>&style.procedural;</title>
+ <programlisting role="php">
<![CDATA[
<?php
function retnull() { return null; }
@@ -106,22 +100,18 @@ foreach (rar_list($a) as $e) {
var_dump(count($a));
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarArchive::isBroken</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarArchive::isBroken</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/tostring.xml b/reference/rar/rararchive/tostring.xml
index c45793fa1776..a91eabf554a3 100644
--- a/reference/rar/rararchive/tostring.xml
+++ b/reference/rar/rararchive/tostring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rararchive.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rararchive.tostring">
<refnamediv>
<refname>RarArchive::__toString</refname>
<refpurpose>Get text representation</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>RarArchive::__toString</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Provides a string representation for this <type>RarArchive</type> object. It currently shows
@@ -39,10 +38,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><methodname>RarArchive::__toString</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarArchive::__toString</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$rar_arch = RarArchive::open('latest_winrar.rar');
@@ -51,21 +49,19 @@ $rar_arch->close();
echo $rar_arch."\n";
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar"
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar" (closed)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/extract.xml b/reference/rar/rarentry/extract.xml
index 35f25d0fb801..5f34ecd2218c 100644
--- a/reference/rar/rarentry/extract.xml
+++ b/reference/rar/rarentry/extract.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="rarentry.extract" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.extract">
<refnamediv>
<refname>RarEntry::extract</refname>
<refpurpose>Extract entry from the archive</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -25,56 +25,54 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>dir</parameter></term>
- <listitem>
- <para>
- Path to the directory where files should be extracted. This parameter is
- considered if and only if <parameter>filepath</parameter> is not. If both
- parameters are empty an extraction to the current directory will be
- attempted.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><parameter>filepath</parameter></term>
- <listitem>
- <para>
- Path (relative or absolute) containing the directory and filename of the
- extracted file. This parameter overrides both the parameter
- <parameter>dir</parameter> and the original file name.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><parameter>password</parameter></term>
- <listitem>
- <para>
- The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
- be omitted. If this parameter is omitted and the entry is encrypted, the password given to
- <function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
- or implicitly via <function>rar_open</function>, CRC checking will fail and this method will fail and return &false;.
- If no password is given and one is required, this method will fail and return &false;.
- You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
- </para>
- </listitem>
- </varlistentry>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>dir</parameter></term>
+ <listitem>
+ <para>
+ Path to the directory where files should be extracted. This parameter is
+ considered if and only if <parameter>filepath</parameter> is not. If both
+ parameters are empty an extraction to the current directory will be
+ attempted.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
- <term><parameter>extended_data</parameter></term>
+ <term><parameter>filepath</parameter></term>
<listitem>
<para>
- If &true;, extended information such as NTFS ACLs and Unix owner information will be set in the extract
- files, as long as it's present in the archive.
+ Path (relative or absolute) containing the directory and filename of the
+ extracted file. This parameter overrides both the parameter
+ <parameter>dir</parameter> and the original file name.
</para>
</listitem>
</varlistentry>
- </variablelist>
- </para>
+
+ <varlistentry>
+ <term><parameter>password</parameter></term>
+ <listitem>
+ <para>
+ The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
+ be omitted. If this parameter is omitted and the entry is encrypted, the password given to
+ <function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
+ or implicitly via <function>rar_open</function>, CRC checking will fail and this method will fail and return &false;.
+ If no password is given and one is required, this method will fail and return &false;.
+ You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><parameter>extended_data</parameter></term>
+ <listitem>
+ <para>
+ If &true;, extended information such as NTFS ACLs and Unix owner information will be set in the extract
+ files, as long as it's present in the archive.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<warning>
<para>Prior to version 2.0.0, this function would not handle relative
paths correctly. Use <function>realpath</function> as a workaround.</para>
@@ -90,32 +88,30 @@
<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>
- <parameter>extended_data</parameter> was added.
- </entry>
- </row>
- <row>
- <entry>PECL rar 3.0.0</entry>
- <entry>
- Support for RAR archives with repeated entry names is no longer defective.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </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>
+ <parameter>extended_data</parameter> was added.
+ </entry>
+ </row>
+ <row>
+ <entry>PECL rar 3.0.0</entry>
+ <entry>
+ Support for RAR archives with repeated entry names is no longer defective.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
@@ -163,19 +159,16 @@ rar_close($rar_file);
</example>
</para>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarEntry::getStream</methodname></member>
- <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarEntry::getStream</methodname></member>
+ <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getattr.xml b/reference/rar/rarentry/getattr.xml
index 35f2e1caebd7..1d7b0c906008 100644
--- a/reference/rar/rarentry/getattr.xml
+++ b/reference/rar/rarentry/getattr.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="rarentry.getattr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getattr">
<refnamediv>
<refname>RarEntry::getAttr</refname>
<refpurpose>Get attributes of the entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -13,10 +13,10 @@
<void/>
</methodsynopsis>
<para>
- Returns the OS-dependent attributes of the archive entry.
+ Returns the OS-dependent attributes of the archive entry.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -31,10 +31,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><methodname>RarEntry::getAttr</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarEntry::getAttr</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -89,24 +88,20 @@ rar_close($rar_file);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarEntry::getHostOs</methodname></member>
- <member>The constants in <classname>RarEntry</classname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarEntry::getHostOs</methodname></member>
+ <member>The constants in <classname>RarEntry</classname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getcrc.xml b/reference/rar/rarentry/getcrc.xml
index 3ed888b6d8a1..abd0b2abf478 100644
--- a/reference/rar/rarentry/getcrc.xml
+++ b/reference/rar/rarentry/getcrc.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getcrc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getcrc">
<refnamediv>
<refname>RarEntry::getCrc</refname>
<refpurpose>Get CRC of the entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,7 +16,7 @@
Returns an hexadecimal string representation of the CRC of the archive entry.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -32,30 +31,27 @@
<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 2.0.0</entry>
- <entry>
- This method now returns correct values for multiple volume archives.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL rar 2.0.0</entry>
+ <entry>
+ This method now returns correct values for multiple volume archives.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/gethostos.xml b/reference/rar/rarentry/gethostos.xml
index 940a607e5e35..a4cc08796c25 100644
--- a/reference/rar/rarentry/gethostos.xml
+++ b/reference/rar/rarentry/gethostos.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.gethostos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.gethostos">
<refnamediv>
<refname>RarEntry::getHostOs</refname>
<refpurpose>Get entry host OS</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,7 +16,7 @@
Returns the code of the host OS of the archive entry.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -68,7 +67,7 @@ switch ($entry->getHostOs()) {
]]>
</programlisting>
</example>
-
+
<example>
<title><methodname>RarEntry::getHostOs</methodname> example (version <= 1.0.0)</title>
<programlisting role="php">
@@ -106,18 +105,15 @@ switch ($entry->getHostOs()) {
</example>
</para>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarEntry::extract</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarEntry::extract</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getmethod.xml b/reference/rar/rarentry/getmethod.xml
index ad3099b5e156..137a958f3cf7 100644
--- a/reference/rar/rarentry/getmethod.xml
+++ b/reference/rar/rarentry/getmethod.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getmethod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getmethod">
<refnamediv>
<refname>RarEntry::getMethod</refname>
<refpurpose>Get pack method of the entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -18,7 +17,7 @@
current archive entry.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -33,10 +32,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><methodname>RarEntry::getMethod</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarEntry::getMethod</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -48,13 +46,11 @@ echo "Method number: " . $entry->getMethod();
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getname.xml b/reference/rar/rarentry/getname.xml
index c41985da1b19..d2d1e56f7fad 100644
--- a/reference/rar/rarentry/getname.xml
+++ b/reference/rar/rarentry/getname.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getname">
<refnamediv>
<refname>RarEntry::getName</refname>
<refpurpose>Get name of the entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,7 +16,7 @@
Returns the name (with path) of the archive entry.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -32,34 +31,31 @@
<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 2.0.0</entry>
- <entry>
- As of version 2.0.0, the returned string is encoded in Unicode/UTF-8.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL rar 2.0.0</entry>
+ <entry>
+ As of version 2.0.0, the returned string is encoded in Unicode/UTF-8.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><methodname>RarEntry::getName</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarEntry::getName</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -82,13 +78,11 @@ echo "Entry name: " . mb_convert_encoding(
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getpackedsize.xml b/reference/rar/rarentry/getpackedsize.xml
index b1673763857c..7ef77fdcf93c 100644
--- a/reference/rar/rarentry/getpackedsize.xml
+++ b/reference/rar/rarentry/getpackedsize.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getpackedsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getpackedsize">
<refnamediv>
<refname>RarEntry::getPackedSize</refname>
<refpurpose>Get packed size of the entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,7 +21,7 @@
<constant>PHP_INT_MAX</constant>.</para>
</note>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -37,36 +36,33 @@
<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 2.0.0</entry>
- <entry>
- This method now returns correct values of packed sizes bigger than 2 GiB
- on platforms with 64-bit <type>int</type>s and never
- returns negative values on other platforms.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL rar 2.0.0</entry>
+ <entry>
+ This method now returns correct values of packed sizes bigger than 2 GiB
+ on platforms with 64-bit <type>int</type>s and never
+ returns negative values on other platforms.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><methodname>RarEntry::getPackedSize</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarEntry::getPackedSize</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -78,13 +74,11 @@ echo "Packed size of " . $entry->getName() . " = " . $entry->getPackedSize() . "
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getstream.xml b/reference/rar/rarentry/getstream.xml
index 5e7828deb8b9..388f075f2b96 100644
--- a/reference/rar/rarentry/getstream.xml
+++ b/reference/rar/rarentry/getstream.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getstream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getstream">
<refnamediv>
<refname>RarEntry::getStream</refname>
<refpurpose>Get file handler for entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -28,26 +27,24 @@
to check for integrity, if he so wishes.</para>
</warning>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>password</parameter></term>
- <listitem>
- <para>
- The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
- be omitted. If this parameter is omitted and the entry is encrypted, the password given to
- <function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
- or implicitly via <function>rar_open</function>, this method's resulting stream will produce wrong
- output. If no password is given and one is required, this method will fail and return &false;.
- You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>password</parameter></term>
+ <listitem>
+ <para>
+ The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
+ be omitted. If this parameter is omitted and the entry is encrypted, the password given to
+ <function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
+ or implicitly via <function>rar_open</function>, this method's resulting stream will produce wrong
+ output. If no password is given and one is required, this method will fail and return &false;.
+ You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -56,37 +53,34 @@
The file handler &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>
- Support for RAR archives with repeated entry names is no longer defective.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </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>
+ Support for RAR archives with repeated entry names is no longer defective.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><methodname>RarEntry::getStream</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarEntry::getStream</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -116,23 +110,19 @@ fclose($stream);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
-
+
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarEntry::extract</methodname></member>
- <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarEntry::extract</methodname></member>
+ <member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getunpackedsize.xml b/reference/rar/rarentry/getunpackedsize.xml
index c59133a747b0..70e88eeedb0f 100644
--- a/reference/rar/rarentry/getunpackedsize.xml
+++ b/reference/rar/rarentry/getunpackedsize.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getunpackedsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getunpackedsize">
<refnamediv>
<refname>RarEntry::getUnpackedSize</refname>
<refpurpose>Get unpacked size of the entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,7 +21,7 @@
<constant>PHP_INT_MAX</constant>.</para>
</note>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -37,36 +36,33 @@
<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 2.0.0</entry>
- <entry>
- This method now returns correct values of unpacked sizes bigger than
- 2 GiB on platforms with 64-bit <type>int</type>s and never
- returns negative values on other platforms.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL rar 2.0.0</entry>
+ <entry>
+ This method now returns correct values of unpacked sizes bigger than
+ 2 GiB on platforms with 64-bit <type>int</type>s and never
+ returns negative values on other platforms.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.returnvalues;
- <para>
- <example>
- <title><methodname>RarEntry::getUnpackedSize</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarEntry::getUnpackedSize</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -78,13 +74,11 @@ echo "Unpacked size of " . $entry->getName() . " = " . $entry->getPackedSize() .
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/getversion.xml b/reference/rar/rarentry/getversion.xml
index 5e6069c0cb16..2d7e5099030f 100644
--- a/reference/rar/rarentry/getversion.xml
+++ b/reference/rar/rarentry/getversion.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getversion" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getversion">
<refnamediv>
<refname>RarEntry::getVersion</refname>
<refpurpose>Get minimum version of RAR program required to unpack the entry</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -18,7 +17,7 @@
It is encoded as 10 * major version + minor version.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -33,10 +32,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><methodname>RarEntry::getVersion</methodname> example</title>
- <programlisting role="php">
+ <example>
+ <title><methodname>RarEntry::getVersion</methodname> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -48,13 +46,11 @@ echo "Rar version required for unpacking: " . $entry->getVersion();
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarexception/isusingexceptions.xml b/reference/rar/rarexception/isusingexceptions.xml
index 269db2f539e7..af5fe7fd317f 100644
--- a/reference/rar/rarexception/isusingexceptions.xml
+++ b/reference/rar/rarexception/isusingexceptions.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarexception.isusingexceptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarexception.isusingexceptions">
<refnamediv>
<refname>RarException::isUsingExceptions</refname>
<refpurpose>Check whether error handling with exceptions is in use</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>RarException::isUsingExceptions</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Checks whether the RAR functions will emit warnings and return error values or whether they
@@ -34,39 +33,34 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>RarException::isUsingExceptions</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>RarException::isUsingExceptions</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
//The default is not to use exceptions
var_dump(RarException::isUsingExceptions());
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarException::setUsingExceptions</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarException::setUsingExceptions</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarexception/setusingexceptions.xml b/reference/rar/rarexception/setusingexceptions.xml
index e99025587bf7..d1dcac32d3c3 100644
--- a/reference/rar/rarexception/setusingexceptions.xml
+++ b/reference/rar/rarexception/setusingexceptions.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarexception.setusingexceptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarexception.setusingexceptions">
<refnamediv>
<refname>RarException::setUsingExceptions</refname>
<refpurpose>Activate and deactivate error handling with exceptions</refpurpose>
@@ -25,7 +24,7 @@
attempting some operations on a closed <type>RarArchive</type> object or a <type>RarEntry</type> object relative to the first;
</simpara>
</listitem>
-
+
<listitem>
<simpara>
attempting to get an entry that does not exist with <methodname>RarArchive::getEntry</methodname>.
@@ -37,18 +36,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>using_exceptions</parameter></term>
- <listitem>
- <para>
- Should be &true; to activate exception throwing, &false; to deactivate (the default).
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>using_exceptions</parameter></term>
+ <listitem>
+ <para>
+ Should be &true; to activate exception throwing, &false; to deactivate (the default).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,10 +57,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>RarException::setUsingExceptions</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>RarException::setUsingExceptions</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
var_dump(RarException::isUsingExceptions());
@@ -76,9 +72,9 @@ $arch = RarArchive::open("does_not_exist.rar");
var_dump($arch); //not reached
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
bool(false)
@@ -92,23 +88,19 @@ Stack trace:
#1 {main}
thrown in C:\php_rar\trunk\tests\test.php on line 8
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>RarException::isUsingExceptions</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>RarException::isUsingExceptions</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml