| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| <title>Code Coverage for D:\work\log4php-trunk\src\main\php/LoggerNDC.php</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <link href="css/bootstrap.min.css" rel="stylesheet"> |
| <link href="css/bootstrap-responsive.min.css" rel="stylesheet"> |
| <link href="css/style.css" rel="stylesheet"> |
| <!--[if lt IE 9]> |
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| </head> |
| <body> |
| <header> |
| <div class="container"> |
| <div class="row"> |
| <div class="span12"> |
| <ul class="breadcrumb"> |
| <li><a href="index.html">D:\work\log4php-trunk\src\main\php</a> <span class="divider">/</span></li> |
| <li class="active">LoggerNDC.php</li> |
| |
| </ul> |
| </div> |
| </div> |
| </div> |
| </header> |
| <div class="container"> |
| <table class="table table-bordered"> |
| <thead> |
| <tr> |
| <td> </td> |
| <td colspan="10"><div align="center"><strong>Code Coverage</strong></div></td> |
| </tr> |
| <tr> |
| <td> </td> |
| <td colspan="3"><div align="center"><strong>Classes and Traits</strong></div></td> |
| <td colspan="4"><div align="center"><strong>Functions and Methods</strong></div></td> |
| <td colspan="3"><div align="center"><strong>Lines</strong></div></td> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="success">Total</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">8 / 8</div></td> |
| <td class="success small"><acronym title="Change Risk Anti-Patterns (CRAP) Index">CRAP</acronym></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">19 / 19</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success">LoggerNDC</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">8 / 8</div></td> |
| <td class="success small">11</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">19 / 19</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#109">clear()</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">1</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">2 / 2</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#117">get()</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">1</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#127">getDepth()</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">1</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#140">pop()</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">2</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">3 / 3</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#156">peek()</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">2</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">3 / 3</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#172">push($message)</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">1</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">2 / 2</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#179">remove()</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">1</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">2 / 2</div></td> |
| </tr> |
| |
| <tr> |
| <td class="success" colspan="4"> <a href="#197">setMaxDepth($maxDepth)</a></td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">1 / 1</div></td> |
| <td class="success small">2</td> |
| <td class="success big"> <div class="progress progress-success" style="width: 100px;"> |
| <div class="bar" style="width: 100.00%;"></div> |
| </div> |
| </td> |
| <td class="success small"><div align="right">100.00%</div></td> |
| <td class="success small"><div align="right">5 / 5</div></td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| <table class="table table-borderless table-condensed"> |
| <tbody> |
| <tr><td><div align="right"><a name="1"></a><a href="#1">1</a></div></td><td class="codeLine"><?php</td></tr> |
| <tr><td><div align="right"><a name="2"></a><a href="#2">2</a></div></td><td class="codeLine">/**</td></tr> |
| <tr><td><div align="right"><a name="3"></a><a href="#3">3</a></div></td><td class="codeLine"> * Licensed to the Apache Software Foundation (ASF) under one or more</td></tr> |
| <tr><td><div align="right"><a name="4"></a><a href="#4">4</a></div></td><td class="codeLine"> * contributor license agreements. See the NOTICE file distributed with</td></tr> |
| <tr><td><div align="right"><a name="5"></a><a href="#5">5</a></div></td><td class="codeLine"> * this work for additional information regarding copyright ownership.</td></tr> |
| <tr><td><div align="right"><a name="6"></a><a href="#6">6</a></div></td><td class="codeLine"> * The ASF licenses this file to You under the Apache License, Version 2.0</td></tr> |
| <tr><td><div align="right"><a name="7"></a><a href="#7">7</a></div></td><td class="codeLine"> * (the "License"); you may not use this file except in compliance with</td></tr> |
| <tr><td><div align="right"><a name="8"></a><a href="#8">8</a></div></td><td class="codeLine"> * the License. You may obtain a copy of the License at</td></tr> |
| <tr><td><div align="right"><a name="9"></a><a href="#9">9</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="10"></a><a href="#10">10</a></div></td><td class="codeLine"> * http://www.apache.org/licenses/LICENSE-2.0</td></tr> |
| <tr><td><div align="right"><a name="11"></a><a href="#11">11</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="12"></a><a href="#12">12</a></div></td><td class="codeLine"> * Unless required by applicable law or agreed to in writing, software</td></tr> |
| <tr><td><div align="right"><a name="13"></a><a href="#13">13</a></div></td><td class="codeLine"> * distributed under the License is distributed on an "AS IS" BASIS,</td></tr> |
| <tr><td><div align="right"><a name="14"></a><a href="#14">14</a></div></td><td class="codeLine"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</td></tr> |
| <tr><td><div align="right"><a name="15"></a><a href="#15">15</a></div></td><td class="codeLine"> * See the License for the specific language governing permissions and</td></tr> |
| <tr><td><div align="right"><a name="16"></a><a href="#16">16</a></div></td><td class="codeLine"> * limitations under the License.</td></tr> |
| <tr><td><div align="right"><a name="17"></a><a href="#17">17</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="18"></a><a href="#18">18</a></div></td><td class="codeLine"> * @package log4php</td></tr> |
| <tr><td><div align="right"><a name="19"></a><a href="#19">19</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="20"></a><a href="#20">20</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="21"></a><a href="#21">21</a></div></td><td class="codeLine">/**</td></tr> |
| <tr><td><div align="right"><a name="22"></a><a href="#22">22</a></div></td><td class="codeLine"> * The NDC class implements <i>nested diagnostic contexts</i>.</td></tr> |
| <tr><td><div align="right"><a name="23"></a><a href="#23">23</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="24"></a><a href="#24">24</a></div></td><td class="codeLine"> * NDC was defined by Neil Harrison in the article "Patterns for Logging</td></tr> |
| <tr><td><div align="right"><a name="25"></a><a href="#25">25</a></div></td><td class="codeLine"> * Diagnostic Messages" part of the book <i>"Pattern Languages of</td></tr> |
| <tr><td><div align="right"><a name="26"></a><a href="#26">26</a></div></td><td class="codeLine"> * Program Design 3"</i> edited by Martin et al.</td></tr> |
| <tr><td><div align="right"><a name="27"></a><a href="#27">27</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="28"></a><a href="#28">28</a></div></td><td class="codeLine"> * A Nested Diagnostic Context, or NDC in short, is an instrument</td></tr> |
| <tr><td><div align="right"><a name="29"></a><a href="#29">29</a></div></td><td class="codeLine"> * to distinguish interleaved log output from different sources. Log</td></tr> |
| <tr><td><div align="right"><a name="30"></a><a href="#30">30</a></div></td><td class="codeLine"> * output is typically interleaved when a server handles multiple</td></tr> |
| <tr><td><div align="right"><a name="31"></a><a href="#31">31</a></div></td><td class="codeLine"> * clients near-simultaneously.</td></tr> |
| <tr><td><div align="right"><a name="32"></a><a href="#32">32</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="33"></a><a href="#33">33</a></div></td><td class="codeLine"> * This class is similar to the {@link LoggerMDC} class except that it is</td></tr> |
| <tr><td><div align="right"><a name="34"></a><a href="#34">34</a></div></td><td class="codeLine"> * based on a stack instead of a map.</td></tr> |
| <tr><td><div align="right"><a name="35"></a><a href="#35">35</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="36"></a><a href="#36">36</a></div></td><td class="codeLine"> * Interleaved log output can still be meaningful if each log entry</td></tr> |
| <tr><td><div align="right"><a name="37"></a><a href="#37">37</a></div></td><td class="codeLine"> * from different contexts had a distinctive stamp. This is where NDCs</td></tr> |
| <tr><td><div align="right"><a name="38"></a><a href="#38">38</a></div></td><td class="codeLine"> * come into play.</td></tr> |
| <tr><td><div align="right"><a name="39"></a><a href="#39">39</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="40"></a><a href="#40">40</a></div></td><td class="codeLine"> * <b>Note that NDCs are managed on a per thread basis</b>.</td></tr> |
| <tr><td><div align="right"><a name="41"></a><a href="#41">41</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="42"></a><a href="#42">42</a></div></td><td class="codeLine"> * NDC operations such as {@link push()}, {@link pop()},</td></tr> |
| <tr><td><div align="right"><a name="43"></a><a href="#43">43</a></div></td><td class="codeLine"> * {@link clear()}, {@link getDepth()} and {@link setMaxDepth()}</td></tr> |
| <tr><td><div align="right"><a name="44"></a><a href="#44">44</a></div></td><td class="codeLine"> * affect the NDC of the <i>current</i> thread only. NDCs of other</td></tr> |
| <tr><td><div align="right"><a name="45"></a><a href="#45">45</a></div></td><td class="codeLine"> * threads remain unaffected.</td></tr> |
| <tr><td><div align="right"><a name="46"></a><a href="#46">46</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="47"></a><a href="#47">47</a></div></td><td class="codeLine"> * For example, a servlet can build a per client request NDC</td></tr> |
| <tr><td><div align="right"><a name="48"></a><a href="#48">48</a></div></td><td class="codeLine"> * consisting the clients host name and other information contained in</td></tr> |
| <tr><td><div align="right"><a name="49"></a><a href="#49">49</a></div></td><td class="codeLine"> * the the request. <i>Cookies</i> are another source of distinctive</td></tr> |
| <tr><td><div align="right"><a name="50"></a><a href="#50">50</a></div></td><td class="codeLine"> * information. To build an NDC one uses the {@link push()}</td></tr> |
| <tr><td><div align="right"><a name="51"></a><a href="#51">51</a></div></td><td class="codeLine"> * operation.</td></tr> |
| <tr><td><div align="right"><a name="52"></a><a href="#52">52</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="53"></a><a href="#53">53</a></div></td><td class="codeLine"> * Simply put,</td></tr> |
| <tr><td><div align="right"><a name="54"></a><a href="#54">54</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="55"></a><a href="#55">55</a></div></td><td class="codeLine"> * - Contexts can be nested.</td></tr> |
| <tr><td><div align="right"><a name="56"></a><a href="#56">56</a></div></td><td class="codeLine"> * - When entering a context, call <kbd>LoggerNDC::push()</kbd></td></tr> |
| <tr><td><div align="right"><a name="57"></a><a href="#57">57</a></div></td><td class="codeLine"> * As a side effect, if there is no nested diagnostic context for the</td></tr> |
| <tr><td><div align="right"><a name="58"></a><a href="#58">58</a></div></td><td class="codeLine"> * current thread, this method will create it.</td></tr> |
| <tr><td><div align="right"><a name="59"></a><a href="#59">59</a></div></td><td class="codeLine"> * - When leaving a context, call <kbd>LoggerNDC::pop()</kbd></td></tr> |
| <tr><td><div align="right"><a name="60"></a><a href="#60">60</a></div></td><td class="codeLine"> * - <b>When exiting a thread make sure to call {@link remove()}</b></td></tr> |
| <tr><td><div align="right"><a name="61"></a><a href="#61">61</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="62"></a><a href="#62">62</a></div></td><td class="codeLine"> * There is no penalty for forgetting to match each</td></tr> |
| <tr><td><div align="right"><a name="63"></a><a href="#63">63</a></div></td><td class="codeLine"> * <kbd>push</kbd> operation with a corresponding <kbd>pop</kbd>,</td></tr> |
| <tr><td><div align="right"><a name="64"></a><a href="#64">64</a></div></td><td class="codeLine"> * except the obvious mismatch between the real application context</td></tr> |
| <tr><td><div align="right"><a name="65"></a><a href="#65">65</a></div></td><td class="codeLine"> * and the context set in the NDC.</td></tr> |
| <tr><td><div align="right"><a name="66"></a><a href="#66">66</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="67"></a><a href="#67">67</a></div></td><td class="codeLine"> * If configured to do so, {@link LoggerPatternLayout} and {@link LoggerLayoutTTCC}</td></tr> |
| <tr><td><div align="right"><a name="68"></a><a href="#68">68</a></div></td><td class="codeLine"> * instances automatically retrieve the nested diagnostic</td></tr> |
| <tr><td><div align="right"><a name="69"></a><a href="#69">69</a></div></td><td class="codeLine"> * context for the current thread without any user intervention.</td></tr> |
| <tr><td><div align="right"><a name="70"></a><a href="#70">70</a></div></td><td class="codeLine"> * Hence, even if a servlet is serving multiple clients</td></tr> |
| <tr><td><div align="right"><a name="71"></a><a href="#71">71</a></div></td><td class="codeLine"> * simultaneously, the logs emanating from the same code (belonging to</td></tr> |
| <tr><td><div align="right"><a name="72"></a><a href="#72">72</a></div></td><td class="codeLine"> * the same category) can still be distinguished because each client</td></tr> |
| <tr><td><div align="right"><a name="73"></a><a href="#73">73</a></div></td><td class="codeLine"> * request will have a different NDC tag.</td></tr> |
| <tr><td><div align="right"><a name="74"></a><a href="#74">74</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="75"></a><a href="#75">75</a></div></td><td class="codeLine"> * Example:</td></tr> |
| <tr><td><div align="right"><a name="76"></a><a href="#76">76</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="77"></a><a href="#77">77</a></div></td><td class="codeLine"> * {@example ../../examples/php/ndc.php 19}<br></td></tr> |
| <tr><td><div align="right"><a name="78"></a><a href="#78">78</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="79"></a><a href="#79">79</a></div></td><td class="codeLine"> * With the properties file:</td></tr> |
| <tr><td><div align="right"><a name="80"></a><a href="#80">80</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="81"></a><a href="#81">81</a></div></td><td class="codeLine"> * {@example ../../examples/resources/ndc.properties 18}<br></td></tr> |
| <tr><td><div align="right"><a name="82"></a><a href="#82">82</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="83"></a><a href="#83">83</a></div></td><td class="codeLine"> * Will result in the following (notice the conn and client ids):</td></tr> |
| <tr><td><div align="right"><a name="84"></a><a href="#84">84</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="85"></a><a href="#85">85</a></div></td><td class="codeLine"> * <pre></td></tr> |
| <tr><td><div align="right"><a name="86"></a><a href="#86">86</a></div></td><td class="codeLine"> * 2009-09-13 19:04:27 DEBUG root conn=1234: just received a new connection in src/examples/php/ndc.php at 23</td></tr> |
| <tr><td><div align="right"><a name="87"></a><a href="#87">87</a></div></td><td class="codeLine"> * 2009-09-13 19:04:27 DEBUG root conn=1234 client=ab23: some more messages that can in src/examples/php/ndc.php at 25</td></tr> |
| <tr><td><div align="right"><a name="88"></a><a href="#88">88</a></div></td><td class="codeLine"> * 2009-09-13 19:04:27 DEBUG root conn=1234 client=ab23: now related to a client in src/examples/php/ndc.php at 26</td></tr> |
| <tr><td><div align="right"><a name="89"></a><a href="#89">89</a></div></td><td class="codeLine"> * 2009-09-13 19:04:27 DEBUG root : back and waiting for new connections in src/examples/php/ndc.php at 29</td></tr> |
| <tr><td><div align="right"><a name="90"></a><a href="#90">90</a></div></td><td class="codeLine"> * </pre></td></tr> |
| <tr><td><div align="right"><a name="91"></a><a href="#91">91</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="92"></a><a href="#92">92</a></div></td><td class="codeLine"> * @version $Revision: 1350602 $</td></tr> |
| <tr><td><div align="right"><a name="93"></a><a href="#93">93</a></div></td><td class="codeLine"> * @package log4php</td></tr> |
| <tr><td><div align="right"><a name="94"></a><a href="#94">94</a></div></td><td class="codeLine"> * @since 0.3</td></tr> |
| <tr><td><div align="right"><a name="95"></a><a href="#95">95</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="96"></a><a href="#96">96</a></div></td><td class="codeLine">class LoggerNDC {</td></tr> |
| <tr><td><div align="right"><a name="97"></a><a href="#97">97</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="98"></a><a href="#98">98</a></div></td><td class="codeLine"> /** This is the repository of NDC stack */</td></tr> |
| <tr><td><div align="right"><a name="99"></a><a href="#99">99</a></div></td><td class="codeLine"> private static $stack = array();</td></tr> |
| <tr><td><div align="right"><a name="100"></a><a href="#100">100</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="101"></a><a href="#101">101</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="102"></a><a href="#102">102</a></div></td><td class="codeLine"> * Clear any nested diagnostic information if any. This method is</td></tr> |
| <tr><td><div align="right"><a name="103"></a><a href="#103">103</a></div></td><td class="codeLine"> * useful in cases where the same thread can be potentially used</td></tr> |
| <tr><td><div align="right"><a name="104"></a><a href="#104">104</a></div></td><td class="codeLine"> * over and over in different unrelated contexts.</td></tr> |
| <tr><td><div align="right"><a name="105"></a><a href="#105">105</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="106"></a><a href="#106">106</a></div></td><td class="codeLine"> * <p>This method is equivalent to calling the {@link setMaxDepth()}</td></tr> |
| <tr><td><div align="right"><a name="107"></a><a href="#107">107</a></div></td><td class="codeLine"> * method with a zero <var>maxDepth</var> argument.</td></tr> |
| <tr><td><div align="right"><a name="108"></a><a href="#108">108</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="109"></a><a href="#109">109</a></div></td><td class="codeLine"> public static function clear() {</td></tr> |
| <tr class="success popin" data-title="3 tests cover line 110" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li><li class="success">LoggerNDCTest::testMaxDepth</li><li class="success">LoggerLayoutXmlTest::testNDC</li></ul>" data-placement="bottom"><td><div align="right"><a name="110"></a><a href="#110">110</a></div></td><td class="codeLine"> self::$stack = array();</td></tr> |
| <tr class="success popin" data-title="3 tests cover line 111" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li><li class="success">LoggerNDCTest::testMaxDepth</li><li class="success">LoggerLayoutXmlTest::testNDC</li></ul>" data-placement="bottom"><td><div align="right"><a name="111"></a><a href="#111">111</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="112"></a><a href="#112">112</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="113"></a><a href="#113">113</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="114"></a><a href="#114">114</a></div></td><td class="codeLine"> * Never use this method directly, use the {@link LoggerLoggingEvent::getNDC()} method instead.</td></tr> |
| <tr><td><div align="right"><a name="115"></a><a href="#115">115</a></div></td><td class="codeLine"> * @return array</td></tr> |
| <tr><td><div align="right"><a name="116"></a><a href="#116">116</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="117"></a><a href="#117">117</a></div></td><td class="codeLine"> public static function get() {</td></tr> |
| <tr class="success popin" data-title="12 tests cover line 118" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li><li class="success">LoggerNDCTest::testMaxDepth</li><li class="success">LoggerLayoutHtmlTest::testErrorLayout</li><li class="success">LoggerLayoutHtmlTest::testWarnLayout</li><li class="success">LoggerLayoutTTCCTest::testErrorLayout</li><li class="success">LoggerLayoutTTCCTest::testWarnLayout</li><li class="success">LoggerLayoutXmlTest::testErrorLayout</li><li class="success">LoggerLayoutXmlTest::testWarnLayout</li><li class="success">LoggerLayoutXmlTest::testLog4JNamespaceErrorLayout</li><li class="success">LoggerLayoutXmlTest::testNDC</li><li class="success">LoggerLayoutXmlTest::testMDC</li><li class="success">LoggerPatternConverterTest::testNDC</li></ul>" data-placement="bottom"><td><div align="right"><a name="118"></a><a href="#118">118</a></div></td><td class="codeLine"> return implode(' ', self::$stack);</td></tr> |
| <tr><td><div align="right"><a name="119"></a><a href="#119">119</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="120"></a><a href="#120">120</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="121"></a><a href="#121">121</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="122"></a><a href="#122">122</a></div></td><td class="codeLine"> * Get the current nesting depth of this diagnostic context.</td></tr> |
| <tr><td><div align="right"><a name="123"></a><a href="#123">123</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="124"></a><a href="#124">124</a></div></td><td class="codeLine"> * @see setMaxDepth()</td></tr> |
| <tr><td><div align="right"><a name="125"></a><a href="#125">125</a></div></td><td class="codeLine"> * @return integer</td></tr> |
| <tr><td><div align="right"><a name="126"></a><a href="#126">126</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="127"></a><a href="#127">127</a></div></td><td class="codeLine"> public static function getDepth() {</td></tr> |
| <tr class="success popin" data-title="2 tests cover line 128" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li><li class="success">LoggerNDCTest::testMaxDepth</li></ul>" data-placement="bottom"><td><div align="right"><a name="128"></a><a href="#128">128</a></div></td><td class="codeLine"> return count(self::$stack);</td></tr> |
| <tr><td><div align="right"><a name="129"></a><a href="#129">129</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="130"></a><a href="#130">130</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="131"></a><a href="#131">131</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="132"></a><a href="#132">132</a></div></td><td class="codeLine"> * Clients should call this method before leaving a diagnostic</td></tr> |
| <tr><td><div align="right"><a name="133"></a><a href="#133">133</a></div></td><td class="codeLine"> * context.</td></tr> |
| <tr><td><div align="right"><a name="134"></a><a href="#134">134</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="135"></a><a href="#135">135</a></div></td><td class="codeLine"> * <p>The returned value is the value that was pushed last. If no</td></tr> |
| <tr><td><div align="right"><a name="136"></a><a href="#136">136</a></div></td><td class="codeLine"> * context is available, then the empty string "" is returned.</p></td></tr> |
| <tr><td><div align="right"><a name="137"></a><a href="#137">137</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="138"></a><a href="#138">138</a></div></td><td class="codeLine"> * @return string The innermost diagnostic context.</td></tr> |
| <tr><td><div align="right"><a name="139"></a><a href="#139">139</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="140"></a><a href="#140">140</a></div></td><td class="codeLine"> public static function pop() {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 141" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="141"></a><a href="#141">141</a></div></td><td class="codeLine"> if(count(self::$stack) > 0) {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 142" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="142"></a><a href="#142">142</a></div></td><td class="codeLine"> return array_pop(self::$stack);</td></tr> |
| <tr><td><div align="right"><a name="143"></a><a href="#143">143</a></div></td><td class="codeLine"> } else {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 144" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="144"></a><a href="#144">144</a></div></td><td class="codeLine"> return '';</td></tr> |
| <tr><td><div align="right"><a name="145"></a><a href="#145">145</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="146"></a><a href="#146">146</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="147"></a><a href="#147">147</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="148"></a><a href="#148">148</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="149"></a><a href="#149">149</a></div></td><td class="codeLine"> * Looks at the last diagnostic context at the top of this NDC</td></tr> |
| <tr><td><div align="right"><a name="150"></a><a href="#150">150</a></div></td><td class="codeLine"> * without removing it.</td></tr> |
| <tr><td><div align="right"><a name="151"></a><a href="#151">151</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="152"></a><a href="#152">152</a></div></td><td class="codeLine"> * <p>The returned value is the value that was pushed last. If no</td></tr> |
| <tr><td><div align="right"><a name="153"></a><a href="#153">153</a></div></td><td class="codeLine"> * context is available, then the empty string "" is returned.</p></td></tr> |
| <tr><td><div align="right"><a name="154"></a><a href="#154">154</a></div></td><td class="codeLine"> * @return string The innermost diagnostic context.</td></tr> |
| <tr><td><div align="right"><a name="155"></a><a href="#155">155</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="156"></a><a href="#156">156</a></div></td><td class="codeLine"> public static function peek() {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 157" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="157"></a><a href="#157">157</a></div></td><td class="codeLine"> if(count(self::$stack) > 0) {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 158" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="158"></a><a href="#158">158</a></div></td><td class="codeLine"> return end(self::$stack);</td></tr> |
| <tr><td><div align="right"><a name="159"></a><a href="#159">159</a></div></td><td class="codeLine"> } else {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 160" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="160"></a><a href="#160">160</a></div></td><td class="codeLine"> return '';</td></tr> |
| <tr><td><div align="right"><a name="161"></a><a href="#161">161</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="162"></a><a href="#162">162</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="163"></a><a href="#163">163</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="164"></a><a href="#164">164</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="165"></a><a href="#165">165</a></div></td><td class="codeLine"> * Push new diagnostic context information for the current thread.</td></tr> |
| <tr><td><div align="right"><a name="166"></a><a href="#166">166</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="167"></a><a href="#167">167</a></div></td><td class="codeLine"> * <p>The contents of the <var>message</var> parameter is</td></tr> |
| <tr><td><div align="right"><a name="168"></a><a href="#168">168</a></div></td><td class="codeLine"> * determined solely by the client.</td></tr> |
| <tr><td><div align="right"><a name="169"></a><a href="#169">169</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="170"></a><a href="#170">170</a></div></td><td class="codeLine"> * @param string $message The new diagnostic context information.</td></tr> |
| <tr><td><div align="right"><a name="171"></a><a href="#171">171</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="172"></a><a href="#172">172</a></div></td><td class="codeLine"> public static function push($message) {</td></tr> |
| <tr class="success popin" data-title="4 tests cover line 173" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li><li class="success">LoggerNDCTest::testMaxDepth</li><li class="success">LoggerLayoutXmlTest::testNDC</li><li class="success">LoggerPatternConverterTest::testNDC</li></ul>" data-placement="bottom"><td><div align="right"><a name="173"></a><a href="#173">173</a></div></td><td class="codeLine"> array_push(self::$stack, (string)$message);</td></tr> |
| <tr class="success popin" data-title="4 tests cover line 174" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li><li class="success">LoggerNDCTest::testMaxDepth</li><li class="success">LoggerLayoutXmlTest::testNDC</li><li class="success">LoggerPatternConverterTest::testNDC</li></ul>" data-placement="bottom"><td><div align="right"><a name="174"></a><a href="#174">174</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="175"></a><a href="#175">175</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="176"></a><a href="#176">176</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="177"></a><a href="#177">177</a></div></td><td class="codeLine"> * Remove the diagnostic context for this thread.</td></tr> |
| <tr><td><div align="right"><a name="178"></a><a href="#178">178</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="179"></a><a href="#179">179</a></div></td><td class="codeLine"> public static function remove() {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 180" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="180"></a><a href="#180">180</a></div></td><td class="codeLine"> LoggerNDC::clear();</td></tr> |
| <tr class="success popin" data-title="1 test covers line 181" data-content="<ul><li class="success">LoggerNDCTest::testItemHandling</li></ul>" data-placement="bottom"><td><div align="right"><a name="181"></a><a href="#181">181</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="182"></a><a href="#182">182</a></div></td><td class="codeLine"></td></tr> |
| <tr><td><div align="right"><a name="183"></a><a href="#183">183</a></div></td><td class="codeLine"> /**</td></tr> |
| <tr><td><div align="right"><a name="184"></a><a href="#184">184</a></div></td><td class="codeLine"> * Set maximum depth of this diagnostic context. If the current</td></tr> |
| <tr><td><div align="right"><a name="185"></a><a href="#185">185</a></div></td><td class="codeLine"> * depth is smaller or equal to <var>maxDepth</var>, then no</td></tr> |
| <tr><td><div align="right"><a name="186"></a><a href="#186">186</a></div></td><td class="codeLine"> * action is taken.</td></tr> |
| <tr><td><div align="right"><a name="187"></a><a href="#187">187</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="188"></a><a href="#188">188</a></div></td><td class="codeLine"> * <p>This method is a convenient alternative to multiple</td></tr> |
| <tr><td><div align="right"><a name="189"></a><a href="#189">189</a></div></td><td class="codeLine"> * {@link pop()} calls. Moreover, it is often the case that at</td></tr> |
| <tr><td><div align="right"><a name="190"></a><a href="#190">190</a></div></td><td class="codeLine"> * the end of complex call sequences, the depth of the NDC is</td></tr> |
| <tr><td><div align="right"><a name="191"></a><a href="#191">191</a></div></td><td class="codeLine"> * unpredictable. The {@link setMaxDepth()} method circumvents</td></tr> |
| <tr><td><div align="right"><a name="192"></a><a href="#192">192</a></div></td><td class="codeLine"> * this problem.</td></tr> |
| <tr><td><div align="right"><a name="193"></a><a href="#193">193</a></div></td><td class="codeLine"> *</td></tr> |
| <tr><td><div align="right"><a name="194"></a><a href="#194">194</a></div></td><td class="codeLine"> * @param integer $maxDepth</td></tr> |
| <tr><td><div align="right"><a name="195"></a><a href="#195">195</a></div></td><td class="codeLine"> * @see getDepth()</td></tr> |
| <tr><td><div align="right"><a name="196"></a><a href="#196">196</a></div></td><td class="codeLine"> */</td></tr> |
| <tr><td><div align="right"><a name="197"></a><a href="#197">197</a></div></td><td class="codeLine"> public static function setMaxDepth($maxDepth) {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 198" data-content="<ul><li class="success">LoggerNDCTest::testMaxDepth</li></ul>" data-placement="bottom"><td><div align="right"><a name="198"></a><a href="#198">198</a></div></td><td class="codeLine"> $maxDepth = (int)$maxDepth;</td></tr> |
| <tr class="success popin" data-title="1 test covers line 199" data-content="<ul><li class="success">LoggerNDCTest::testMaxDepth</li></ul>" data-placement="bottom"><td><div align="right"><a name="199"></a><a href="#199">199</a></div></td><td class="codeLine"> if(LoggerNDC::getDepth() > $maxDepth) {</td></tr> |
| <tr class="success popin" data-title="1 test covers line 200" data-content="<ul><li class="success">LoggerNDCTest::testMaxDepth</li></ul>" data-placement="bottom"><td><div align="right"><a name="200"></a><a href="#200">200</a></div></td><td class="codeLine"> self::$stack = array_slice(self::$stack, 0, $maxDepth);</td></tr> |
| <tr class="success popin" data-title="1 test covers line 201" data-content="<ul><li class="success">LoggerNDCTest::testMaxDepth</li></ul>" data-placement="bottom"><td><div align="right"><a name="201"></a><a href="#201">201</a></div></td><td class="codeLine"> }</td></tr> |
| <tr class="success popin" data-title="1 test covers line 202" data-content="<ul><li class="success">LoggerNDCTest::testMaxDepth</li></ul>" data-placement="bottom"><td><div align="right"><a name="202"></a><a href="#202">202</a></div></td><td class="codeLine"> }</td></tr> |
| <tr><td><div align="right"><a name="203"></a><a href="#203">203</a></div></td><td class="codeLine">}</td></tr> |
| |
| </tbody> |
| </table> |
| <footer> |
| <h4>Legend</h4> |
| <p> |
| <span class="success"><strong>Executed</strong></span> |
| <span class="danger"><strong>Not Executed</strong></span> |
| <span class="warning"><strong>Dead Code</strong></span> |
| </p> |
| <p> |
| <small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 1.2.3</a> using <a href="http://www.php.net/" target="_top">PHP 5.3.13</a> and <a href="http://phpunit.de/">PHPUnit 3.7.6</a> at Sat Oct 13 8:58:14 BST 2012.</small> |
| </p> |
| </footer> |
| </div> |
| <script src="js/jquery.min.js" type="text/javascript"></script> |
| <script src="js/bootstrap.min.js" type="text/javascript"></script> |
| <script type="text/javascript">$('.popin').popover({trigger: 'hover'});</script> |
| </body> |
| </html> |
