blob: b46c4112ac30a3052752998b2f669253773fe6d3 [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" />
<title>Class LoggerLayoutSimple | 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><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 class="active"><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-LoggerLayoutHtml.html">LoggerLayoutHtml</a></li>
<li><a href="class-LoggerLayoutPattern.html">LoggerLayoutPattern</a></li>
<li><a href="class-LoggerLayoutSerialized.html">LoggerLayoutSerialized</a></li>
<li class="active"><a href="class-LoggerLayoutSimple.html">LoggerLayoutSimple</a></li>
<li><a href="class-LoggerLayoutXml.html">LoggerLayoutXml</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.layouts.html" title="Summary of log4php\layouts"><span>Package</span></a>
</li>
<li class="active">
<span>Class</span> </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>
<div id="content" class="class">
<h1>Class LoggerLayoutSimple</h1>
<div class="description">
<p>A simple layout.</p>
<p>Returns the log statement in a format consisting of the <b>level</b>,
followed by " - " and then the <b>message</b>.</p>
<p>For example the following php and properties files</p>
<p>{@example ../../examples/php/layout_simple.php 19}<br />
</p>
<p>{@example ../../examples/resources/layout_simple.properties 18}<br />
</p>
<p>would result in:</p>
<p><samp>INFO - Hello World!</samp></p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-LoggerConfigurable.html"><span>LoggerConfigurable</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-LoggerLayout.html"><span>LoggerLayout</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>LoggerLayoutSimple</span></b>
</dd>
</dl>
<div class="info">
<b>Package:</b> <a href="package-log4php.html">log4php</a>\<a href="package-log4php.layouts.html">layouts</a><br />
<b>Version:</b>
$Revision: 1213283 $<br />
<b>Located at</b> <a href="source-class-LoggerLayoutSimple.html#21-56" title="Go to source code">layouts/LoggerLayoutSimple.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="format" id="_format">
<td class="attributes"><code>
public
string
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_format">#</a>
<code><a href="source-class-LoggerLayoutSimple.html#42-55" title="Go to source code">format</a>( <span><code><a href="class-LoggerLoggingEvent.html">LoggerLoggingEvent</a></code> <var>$event</var></span> )</code>
<div class="description short">
<p>Returns the log statement in a format consisting of the <b>level</b>,
followed by " - " and then the <b>message</b>. For example, <samp> INFO - "A
message" </samp></p>
</div>
<div class="description detailed hidden">
<p>Returns the log statement in a format consisting of the <b>level</b>,
followed by " - " and then the <b>message</b>. For example, <samp> INFO - "A
message" </samp></p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$event</var></dt>
<dd><code><code><a href="class-LoggerLoggingEvent.html">LoggerLoggingEvent</a></code></code><br>$event</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>string</code><br />
</div>
<h4>Overrides</h4>
<div class="list"><code><a href="class-LoggerLayout.html#_format">LoggerLayout::format()</a></code></div>
</div>
</div></td>
</tr>
</table>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-LoggerLayout.html#methods">LoggerLayout</a></caption>
<tr>
<td><code>
<a href="class-LoggerLayout.html#_activateOptions">activateOptions()</a>,
<a href="class-LoggerLayout.html#_getContentType">getContentType()</a>,
<a href="class-LoggerLayout.html#_getFooter">getFooter()</a>,
<a href="class-LoggerLayout.html#_getHeader">getHeader()</a>,
<a href="class-LoggerLayout.html#_warn">warn()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-LoggerConfigurable.html#methods">LoggerConfigurable</a></caption>
<tr>
<td><code>
<a href="class-LoggerConfigurable.html#_setBoolean">setBoolean()</a>,
<a href="class-LoggerConfigurable.html#_setFileSize">setFileSize()</a>,
<a href="class-LoggerConfigurable.html#_setInteger">setInteger()</a>,
<a href="class-LoggerConfigurable.html#_setLevel">setLevel()</a>,
<a href="class-LoggerConfigurable.html#_setNumeric">setNumeric()</a>,
<a href="class-LoggerConfigurable.html#_setPositiveInteger">setPositiveInteger()</a>,
<a href="class-LoggerConfigurable.html#_setString">setString()</a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
Apache log4php API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>