/
debug.xml
156 lines (141 loc) · 4.34 KB
/
debug.xml
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.debug" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SeasLog::debug</refname>
<refpurpose>Record debug log information</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::debug</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>logger</parameter></methodparam>
</methodsynopsis>
<para>
Record debug log information.
<note>
<para>
"DEBUG" - Detailed debug information.Fine-grained information events.
</para>
</note>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
The log message.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
the log information will `log info from neeke`.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return TRUE on record log information success, FALSE on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>SeasLog::debug</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(SeasLog::debug('log message'));
//with content
var_dump(SeasLog::debug('log message from {NAME}',array('NAME' => 'neeke')));
//with tmp logger
var_dump(SeasLog::debug('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger'));
var_dump(SeasLog::getBuffer());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
bool(true)
bool(true)
bool(true)
array(2) {
["/var/log/www/default/20180707.log"]=>
array(2) {
[0]=>
string(81) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message
"
[1]=>
string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke
"
}
["/var/log/www/tmp_logger/20180707.log"]=>
array(1) {
[0]=>
string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke
"
}
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><link linkend="ini.seaslog.default-template">seaslog.default_template</link></member>
<member><methodname>SeasLog::info</methodname></member>
<member><methodname>SeasLog::notice</methodname></member>
<member><methodname>SeasLog::warning</methodname></member>
<member><methodname>SeasLog::error</methodname></member>
<member><methodname>SeasLog::critical</methodname></member>
<member><methodname>SeasLog::alert</methodname></member>
<member><methodname>SeasLog::emergency</methodname></member>
<member><methodname>SeasLog::log</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
-->