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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SeasLog" namespace="" name="SeasLog">
<method name="alert" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record alert log information">Record alert log information. "ALERT" - Action must be taken immediately. Immediate attention should be given to relevant personnel for emergency repairs.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<method name="analyzerCount" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get log count by level, log_path and key_word"/>
<return type="mixed"/>
</docblock>
<parameter name="level" optional="false" byreference="false" type="string"/>
<parameter name="log_path" optional="true" byreference="false" type="string"/>
<parameter name="key_word" optional="true" byreference="false" type="string"/>
</method>
<method name="analyzerDetail" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get log detail by level, log_path, key_word, start, limit, order"/>
<return type="mixed"/>
</docblock>
<parameter name="level" optional="false" byreference="false" type="string"/>
<parameter name="log_path" optional="true" byreference="false" type="string"/>
<parameter name="key_word" optional="true" byreference="false" type="string"/>
<parameter name="start" optional="true" byreference="false" type="int"/>
<parameter name="limit" optional="true" byreference="false" type="int"/>
<parameter name="order" optional="true" byreference="false" type="int"/>
</method>
<method name="closeLoggerStream" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Manually release stream flow from logger"/>
<return type="bool"/>
</docblock>
<parameter name="model" optional="false" byreference="false" type="int"/>
<parameter name="logger" optional="false" byreference="false" type="string"/>
</method>
<method name="critical" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record critical log information">Record critical log information. "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is unavailable.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<method name="debug" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record debug log information">Record debug log information. "DEBUG" - Detailed debug information.Fine-grained information events.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Description"/>
<return type="void"/>
</docblock>
</destructor>
<method name="emergency" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record emergency log information">Record emergency log information. "EMERGENCY" - System is unusable.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<method name="error" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record error log information">Record error log information. "ERROR" - Runtime errors that do not require immediate action but should typically.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<method name="flushBuffer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Flush logs buffer, dump to appender file, or send to remote api with tcp/udp">Flush logs buffer by seaslog.appender: dump to file, or send to remote api with tcp/udp. See also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port</description>
<return type="bool"/>
</docblock>
</method>
<method name="getBasePath" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=""/>
<return type="string"/>
</docblock>
</method>
<method name="getBuffer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the logs buffer in memory as array"/>
<return type="array"/>
</docblock>
</method>
<method name="getBufferEnabled" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Determin if buffer enabled"/>
<return type="bool"/>
</docblock>
</method>
<method name="getDatetimeFormat" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get SeasLog datetime format style"/>
<return type="string"/>
</docblock>
</method>
<method name="getLastLogger" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get SeasLog last logger path"/>
<return type="string"/>
</docblock>
</method>
<method name="getRequestID" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get SeasLog request_id differentiated requests"/>
<return type="string"/>
</docblock>
</method>
<method name="getRequestVariable" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get SeasLog request variable"/>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="int"/>
</method>
<method name="info" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record info log information">Record info log information. "INFO" - Interesting events.Emphasizes the running process of the application.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<method name="log" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The Common Record Log Function"/>
<return type="bool"/>
</docblock>
<parameter name="level" optional="false" byreference="false" type="string"/>
<parameter name="message" optional="true" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<method name="notice" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record notice log information">Record notice log information. "NOTICE" - Normal but significant events.Information that is more important than the INFO level during execution.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
<method name="setBasePath" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set SeasLog base path"/>
<return type="bool"/>
</docblock>
<parameter name="base_path" optional="false" byreference="false" type="string"/>
</method>
<method name="setDatetimeFormat" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set SeasLog datetime format style"/>
<return type="bool"/>
</docblock>
<parameter name="format" optional="false" byreference="false" type="string"/>
</method>
<method name="setLogger" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set SeasLog logger name"/>
<return type="bool"/>
</docblock>
<parameter name="logger" optional="false" byreference="false" type="string"/>
</method>
<method name="setRequestID" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set SeasLog request_id differentiated requests"/>
<return type="bool"/>
</docblock>
<parameter name="request_id" optional="false" byreference="false" type="string"/>
</method>
<method name="setRequestVariable" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Manually set SeasLog request variable"/>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="int"/>
<parameter name="value" optional="false" byreference="false" type="string"/>
</method>
<method name="warning" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Record warning log information">Record warning log information. "WARNING" - Exceptional occurrences that are not errors. Potentially aberrant information that needs attention and needs to be repaired.</description>
<return type="bool"/>
</docblock>
<parameter name="message" optional="false" byreference="false" type="string"/>
<parameter name="content" optional="true" byreference="false" type="object" class="array"/>
<parameter name="logger" optional="true" byreference="false" type="string"/>
</method>
</class>
|