Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / LoggerLocationInfo.html
blob: 1f3897a276185d5f063f873f3926d4115e7f2b91 [file] [log] [blame]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class LoggerLocationInfo</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<script src="../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.png";
imgMinus.src = "../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class LoggerLocationInfo</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The internal representation of caller location information.</p>
<ul class="tags">
<li><span class="field">version:</span> $Revision: 822448 $</li>
<li><span class="field">since:</span> 0.3</li>
</ul>
<p class="notes">
Located in <a class="field" href="_LoggerLocationInfo.php.html">/LoggerLocationInfo.php</a> (line <span class="field">28</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-const-summary"></a>
<div class="info-box">
<div class="info-box-title">Class Constant Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="const-summary">
<div class="const-title">
<img src="../media/images/Constant.png" alt=" " />
<a href="#LOCATION_INFO_NA" title="details" class="const-name">LOCATION_INFO_NA</a> = <span class="var-type"> 'NA'</span>
</div>
</div>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$className" title="details" class="var-name">$className</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$fileName" title="details" class="var-name">$fileName</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$fullInfo" title="details" class="var-name">$fullInfo</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$lineNumber" title="details" class="var-name">$lineNumber</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$methodName" title="details" class="var-name">$methodName</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">LoggerLocationInfo</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$trace</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fqcn</span> = <span class="var-default">null</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getClassName" title="details" class="method-name">getClassName</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getFileName" title="details" class="method-name">getFileName</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getFullInfo" title="details" class="method-name">getFullInfo</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getLineNumber" title="details" class="method-name">getLineNumber</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getMethodName" title="details" class="method-name">getMethodName</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$className" id="$className"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$className</span>
= <span class="var-default"> null</span> (line <span class="line-number">49</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> Caller's fully qualified class name.</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$fileName" id="$fileName"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$fileName</span>
= <span class="var-default"> null</span> (line <span class="line-number">44</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> Caller's file name.</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$fullInfo" id="$fullInfo"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$fullInfo</span>
= <span class="var-default"> null</span> (line <span class="line-number">59</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$lineNumber" id="$lineNumber"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$lineNumber</span>
= <span class="var-default"> null</span> (line <span class="line-number">39</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> Caller's line number.</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$methodName" id="$methodName"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$methodName</span>
= <span class="var-default"> null</span> (line <span class="line-number">54</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> Caller's method name.</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">67</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Instantiate location information based on a <a href="http://www.php.net/debug_backtrace">http://www.php.net/debug_backtrace</a>.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">LoggerLocationInfo</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$trace</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fqcn</span> = <span class="var-default">null</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$trace</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$caller</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$fqcn</span> </li>
</ul>
</div>
<a name="methodgetClassName" id="getClassName"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getClassName</span> (line <span class="line-number">76</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getClassName
</span>
()
</div>
</div>
<a name="methodgetFileName" id="getFileName"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getFileName</span> (line <span class="line-number">84</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the file name of the caller.</p>
<p class="description"><p>This information is not always available.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getFileName
</span>
()
</div>
</div>
<a name="methodgetFullInfo" id="getFullInfo"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getFullInfo</span> (line <span class="line-number">106</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the full information of the caller.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getFullInfo
</span>
()
</div>
</div>
<a name="methodgetLineNumber" id="getLineNumber"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getLineNumber</span> (line <span class="line-number">92</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the line number of the caller.</p>
<p class="description"><p>This information is not always available.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getLineNumber
</span>
()
</div>
</div>
<a name="methodgetMethodName" id="getMethodName"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getMethodName</span> (line <span class="line-number">99</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the method name of the caller.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getMethodName
</span>
()
</div>
</div>
</div>
</div>
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="constLOCATION_INFO_NA" id="LOCATION_INFO_NA"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">LOCATION_INFO_NA</span>
= <span class="const-default"> 'NA'</span>
(line <span class="line-number">34</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">When location information is not available the constant <em>NA</em> is returned. Current value of this string constant is <strong>?</strong>.</p>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 18 Feb 2012 22:32:25 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>