-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathsetusingexceptions.xml
More file actions
132 lines (120 loc) · 3.85 KB
/
setusingexceptions.xml
File metadata and controls
132 lines (120 loc) · 3.85 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ee741f54f831af19f135d1d9894a41477ab896c3 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<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>Active ou désactive les exceptions dans le gestionnaire d'erreurs</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>RarException::setUsingExceptions</methodname>
<methodparam><type>bool</type><parameter>using_exceptions</parameter></methodparam>
</methodsynopsis>
<simpara>
Si et seulement si l'argument vaut &true;, alors, au lieu d'émettre des alertes
et de retourner des valeurs spéciales indiquant une erreur lorsque la
bibliothèque UnRAR rencontre une erreur, une exception de type
<type>RarException</type> est émise.
</simpara>
<simpara>
Les exceptions seront également lancées pour les erreurs suivantes,
qui surviennent en dehors de la bibliothèque (leurs codes erreurs seront -1) :
</simpara>
<itemizedlist>
<listitem>
<simpara>
tentative d'une opération sur un objet <type>RarArchive</type> clos ou
un objet <type>RarEntry</type> relatif au premier ;
</simpara>
</listitem>
<listitem>
<simpara>
tentative de récupération d'une entrée qui n'existe pas avec la méthode
<methodname>RarArchive::getEntry</methodname>.
</simpara>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>using_exceptions</parameter></term>
<listitem>
<simpara>
Doit valoir &true; pour activer l'émission d'exceptions, &false; pour le
désactiver (par défaut).
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.void;
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemple avec <function>RarException::setUsingExceptions</function></title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(RarException::isUsingExceptions());
$arch = RarArchive::open("does_not_exist.rar");
var_dump($arch);
RarException::setUsingExceptions(true);
var_dump(RarException::isUsingExceptions());
$arch = RarArchive::open("does_not_exist.rar");
var_dump($arch); //non atteint
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
bool(false)
Warning: RarArchive::open(): Failed to open does_not_exist.rar: ERAR_EOPEN (file open error) in C:\php_rar\trunk\tests\test.php on line 3
bool(false)
bool(true)
Fatal error: Uncaught exception 'RarException' with message 'unRAR internal error: Failed to open does_not_exist.rar: ERAR_EOPEN (file open error)' in C:\php_rar\trunk\tests\test.php:8
Stack trace:
#0 C:\php_rar\trunk\tests\test.php(8): RarArchive::open('does_not_exist....')
#1 {main}
thrown in C:\php_rar\trunk\tests\test.php on line 8
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>RarException::isUsingExceptions</methodname></member>
</simplelist>
</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
-->