blob: 8166180346fd036de52e98d18cad7b45837bc4d2 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File appenders/LoggerAppenderEcho.php | Apache log4php</title>
<script type="text/javascript" src="resources/combined.js?238209907"></script>
<script type="text/javascript" src="elementlist.js?4055067042"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', "UA-26177991-1"]);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Packages</h3>
<ul>
<li class="active"><a href="package-log4php.html">log4php<span></span></a>
<ul>
<li class="active"><a href="package-log4php.appenders.html">appenders</a>
</li>
<li><a href="package-log4php.configurators.html">configurators</a>
</li>
<li><a href="package-log4php.filters.html">filters</a>
</li>
<li><a href="package-log4php.helpers.html">helpers</a>
</li>
<li><a href="package-log4php.layouts.html">layouts</a>
</li>
<li><a href="package-log4php.pattern.html">pattern</a>
</li>
<li><a href="package-log4php.renderers.html">renderers</a>
</li>
</ul></li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-LoggerAppenderConsole.html">LoggerAppenderConsole</a></li>
<li><a href="class-LoggerAppenderDailyFile.html">LoggerAppenderDailyFile</a></li>
<li class="active"><a href="class-LoggerAppenderEcho.html">LoggerAppenderEcho</a></li>
<li><a href="class-LoggerAppenderFile.html">LoggerAppenderFile</a></li>
<li><a href="class-LoggerAppenderFirePHP.html">LoggerAppenderFirePHP</a></li>
<li><a href="class-LoggerAppenderMail.html">LoggerAppenderMail</a></li>
<li><a href="class-LoggerAppenderMailEvent.html">LoggerAppenderMailEvent</a></li>
<li><a href="class-LoggerAppenderMongoDB.html">LoggerAppenderMongoDB</a></li>
<li><a href="class-LoggerAppenderNull.html">LoggerAppenderNull</a></li>
<li><a href="class-LoggerAppenderPDO.html">LoggerAppenderPDO</a></li>
<li><a href="class-LoggerAppenderPhp.html">LoggerAppenderPhp</a></li>
<li><a href="class-LoggerAppenderRollingFile.html">LoggerAppenderRollingFile</a></li>
<li><a href="class-LoggerAppenderSocket.html">LoggerAppenderSocket</a></li>
<li><a href="class-LoggerAppenderSyslog.html">LoggerAppenderSyslog</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="package-log4php.appenders.html" title="Summary of log4php\appenders"><span>Package</span></a>
</li>
<li>
<a href="class-LoggerAppenderEcho.html" title="Summary of LoggerAppenderEcho"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/**
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Licensed to the Apache Software Foundation (ASF) under one or more
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * contributor license agreements. See the NOTICE file distributed with
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * this work for additional information regarding copyright ownership.
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * The ASF licenses this file to You under the Apache License, Version 2.0
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * (the &quot;License&quot;); you may not use this file except in compliance with
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * the License. You may obtain a copy of the License at
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> *
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * See the License for the specific language governing permissions and
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * limitations under the License.
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> */</span>
</span><span id="18" class="l"><a class="l" href="#18">18: </a>
</span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment">/**
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * LoggerAppenderEcho uses the PHP echo() function to output events.
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> *
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * This appender uses a layout.
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> *
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * ## Configurable parameters: ##
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> *
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * - **htmlLineBreaks** - If set to true, a &lt;br /&gt; element will be inserted
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * before each line break in the logged message. Default is false.
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> *
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * @version $Revision: 1337820 $
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * @package log4php
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * @subpackage appenders
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> * @link http://logging.apache.org/log4php/docs/appenders/echo.html Appender documentation
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> */</span>
</span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-keyword1">class</span> <a id="LoggerAppenderEcho" href="#LoggerAppenderEcho">LoggerAppenderEcho</a> <span class="php-keyword1">extends</span> LoggerAppender {
</span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> * Used to mark first append. Set to false after first append.
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> * @var boolean
</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> */</span>
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$firstAppend" href="#$firstAppend">$firstAppend</a></span> = <span class="php-keyword1">true</span>;
</span><span id="41" class="l"><a class="l" href="#41">41: </a>
</span><span id="42" class="l"><a class="l" href="#42">42: </a> <span class="php-comment">/**
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> * If set to true, a &lt;br /&gt; element will be inserted before each line
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment"> * break in the logged message. Default value is false. @var boolean
</span></span><span id="45" class="l"><a class="l" href="#45">45: </a><span class="php-comment"> */</span>
</span><span id="46" class="l"><a class="l" href="#46">46: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$htmlLineBreaks" href="#$htmlLineBreaks">$htmlLineBreaks</a></span> = <span class="php-keyword1">false</span>;
</span><span id="47" class="l"><a class="l" href="#47">47: </a>
</span><span id="48" class="l"><a class="l" href="#48">48: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_close" href="#_close">close</a>() {
</span><span id="49" class="l"><a class="l" href="#49">49: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-&gt;closed != <span class="php-keyword1">true</span>) {
</span><span id="50" class="l"><a class="l" href="#50">50: </a> <span class="php-keyword1">if</span>(!<span class="php-var">$this</span>-&gt;firstAppend) {
</span><span id="51" class="l"><a class="l" href="#51">51: </a> <span class="php-keyword1">echo</span> <span class="php-var">$this</span>-&gt;layout-&gt;getFooter();
</span><span id="52" class="l"><a class="l" href="#52">52: </a> }
</span><span id="53" class="l"><a class="l" href="#53">53: </a> }
</span><span id="54" class="l"><a class="l" href="#54">54: </a> <span class="php-var">$this</span>-&gt;closed = <span class="php-keyword1">true</span>;
</span><span id="55" class="l"><a class="l" href="#55">55: </a> }
</span><span id="56" class="l"><a class="l" href="#56">56: </a>
</span><span id="57" class="l"><a class="l" href="#57">57: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_append" href="#_append">append</a>(LoggerLoggingEvent <span class="php-var">$event</span>) {
</span><span id="58" class="l"><a class="l" href="#58">58: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-&gt;layout !== <span class="php-keyword1">null</span>) {
</span><span id="59" class="l"><a class="l" href="#59">59: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-&gt;firstAppend) {
</span><span id="60" class="l"><a class="l" href="#60">60: </a> <span class="php-keyword1">echo</span> <span class="php-var">$this</span>-&gt;layout-&gt;getHeader();
</span><span id="61" class="l"><a class="l" href="#61">61: </a> <span class="php-var">$this</span>-&gt;firstAppend = <span class="php-keyword1">false</span>;
</span><span id="62" class="l"><a class="l" href="#62">62: </a> }
</span><span id="63" class="l"><a class="l" href="#63">63: </a> <span class="php-var">$text</span> = <span class="php-var">$this</span>-&gt;layout-&gt;format(<span class="php-var">$event</span>);
</span><span id="64" class="l"><a class="l" href="#64">64: </a>
</span><span id="65" class="l"><a class="l" href="#65">65: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;htmlLineBreaks) {
</span><span id="66" class="l"><a class="l" href="#66">66: </a> <span class="php-var">$text</span> = <span class="php-keyword2">nl2br</span>(<span class="php-var">$text</span>);
</span><span id="67" class="l"><a class="l" href="#67">67: </a> }
</span><span id="68" class="l"><a class="l" href="#68">68: </a> <span class="php-keyword1">echo</span> <span class="php-var">$text</span>;
</span><span id="69" class="l"><a class="l" href="#69">69: </a> }
</span><span id="70" class="l"><a class="l" href="#70">70: </a> }
</span><span id="71" class="l"><a class="l" href="#71">71: </a>
</span><span id="72" class="l"><a class="l" href="#72">72: </a> <span class="php-comment">/**
</span></span><span id="73" class="l"><a class="l" href="#73">73: </a><span class="php-comment"> * Sets the 'htmlLineBreaks' parameter.
</span></span><span id="74" class="l"><a class="l" href="#74">74: </a><span class="php-comment"> * @param boolean $value
</span></span><span id="75" class="l"><a class="l" href="#75">75: </a><span class="php-comment"> */</span>
</span><span id="76" class="l"><a class="l" href="#76">76: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setHtmlLineBreaks" href="#_setHtmlLineBreaks">setHtmlLineBreaks</a>(<span class="php-var">$value</span>) {
</span><span id="77" class="l"><a class="l" href="#77">77: </a> <span class="php-var">$this</span>-&gt;setBoolean(<span class="php-quote">'htmlLineBreaks'</span>, <span class="php-var">$value</span>);
</span><span id="78" class="l"><a class="l" href="#78">78: </a> }
</span><span id="79" class="l"><a class="l" href="#79">79: </a>
</span><span id="80" class="l"><a class="l" href="#80">80: </a> <span class="php-comment">/**
</span></span><span id="81" class="l"><a class="l" href="#81">81: </a><span class="php-comment"> * Returns the 'htmlLineBreaks' parameter.
</span></span><span id="82" class="l"><a class="l" href="#82">82: </a><span class="php-comment"> * @returns boolean
</span></span><span id="83" class="l"><a class="l" href="#83">83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84">84: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getHtmlLineBreaks" href="#_getHtmlLineBreaks">getHtmlLineBreaks</a>() {
</span><span id="85" class="l"><a class="l" href="#85">85: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;htmlLineBreaks;
</span><span id="86" class="l"><a class="l" href="#86">86: </a> }
</span><span id="87" class="l"><a class="l" href="#87">87: </a>}
</span><span id="88" class="l"><a class="l" href="#88">88: </a>
</span><span id="89" class="l"><a class="l" href="#89">89: </a></span></code></pre>
<div id="footer">
Apache log4php API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>