language/predefined/error/construct.xml
3fc56d76de1007a3c4f60b143c60c071f32546fb
...
...
@@ -0,0 +1,84 @@
1
+
<?xml version="1.0" encoding="utf-8"?>
2
+
<!-- $Revision$ -->
3
+
<refentry xml:id="error.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4
+
<refnamediv>
5
+
<refname>Error::__construct</refname>
6
+
<refpurpose>Construct the error object</refpurpose>
7
+
</refnamediv>
8
+

9
+
<refsect1 role="description">
10
+
&reftitle.description;
11
+
<constructorsynopsis role="Error">
12
+
<modifier>public</modifier> <methodname>Error::__construct</methodname>
13
+
<methodparam choice="opt"><type>string</type><parameter>message</parameter><initializer>""</initializer></methodparam>
14
+
<methodparam choice="opt"><type>int</type><parameter>code</parameter><initializer>0</initializer></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>Throwable</type><type>null</type></type><parameter>previous</parameter><initializer>&null;</initializer></methodparam>
16
+
</constructorsynopsis>
17
+
<para>
18
+
Constructs the Error.
19
+
</para>
20
+
</refsect1>
21
+

22
+
<refsect1 role="parameters">
23
+
&reftitle.parameters;
24
+
<para>
25
+
<variablelist>
26
+
<varlistentry>
27
+
<term><parameter>message</parameter></term>
28
+
<listitem>
29
+
<para>
30
+
The error message.
31
+
</para>
32
+
</listitem>
33
+
</varlistentry>
34
+
<varlistentry>
35
+
<term><parameter>code</parameter></term>
36
+
<listitem>
37
+
<para>
38
+
The error code.
39
+
</para>
40
+
</listitem>
41
+
</varlistentry>
42
+
<varlistentry>
43
+
<term><parameter>previous</parameter></term>
44
+
<listitem>
45
+
<para>
46
+
The previous throwable used for the exception chaining.
47
+
</para>
48
+
</listitem>
49
+
</varlistentry>
50
+
</variablelist>
51
+
</para>
52
+
</refsect1>
53
+
54
+
<refsect1 role="notes">
55
+
&reftitle.notes;
56
+
<note>
57
+
<para>
58
+
The <parameter>message</parameter> is <emphasis>NOT</emphasis>
59
+
binary safe.
60
+
</para>
61
+
</note>
62
+
</refsect1>
63
+
64
+
</refentry>
65
+
<!-- Keep this comment at the end of the file
66
+
Local variables:
67
+
mode: sgml
68
+
sgml-omittag:t
69
+
sgml-shorttag:t
70
+
sgml-minimize-attributes:nil
71
+
sgml-always-quote-attributes:t
72
+
sgml-indent-step:1
73
+
sgml-indent-data:t
74
+
indent-tabs-mode:nil
75
+
sgml-parent-document:nil
76
+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
77
+
sgml-exposed-tags:nil
78
+
sgml-local-catalogs:nil
79
+
sgml-local-ecat-files:nil
80
+
End:
81
+
vim600: syn=xml fen fdm=syntax fdl=2 si
82
+
vim: et tw=78 syn=sgml
83
+
vi: ts=1 sw=1
84
+
-->
0
85