Files
sterivein/documentation/api/source-class-Thelia.Log.Destination.TlogDestinationFile.html
2013-02-20 19:07:50 +01:00

253 lines
20 KiB
HTML

<!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 core/lib/Thelia/Log/Destination/TlogDestinationFile.php | thelia</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?394832703"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-Thelia.html">Thelia<span></span></a>
<ul>
<li><a href="namespace-Thelia.Action.html">Action</a>
</li>
<li><a href="namespace-Thelia.Controller.html">Controller</a>
</li>
<li><a href="namespace-Thelia.Core.html">Core<span></span></a>
<ul>
<li><a href="namespace-Thelia.Core.Bundle.html">Bundle</a>
</li>
<li><a href="namespace-Thelia.Core.Event.html">Event</a>
</li>
<li><a href="namespace-Thelia.Core.EventListener.html">EventListener</a>
</li>
<li><a href="namespace-Thelia.Core.Template.html">Template<span></span></a>
<ul>
<li><a href="namespace-Thelia.Core.Template.BaseParam.html">BaseParam</a>
</li>
</ul></li></ul></li>
<li><a href="namespace-Thelia.Exception.html">Exception</a>
</li>
<li class="active"><a href="namespace-Thelia.Log.html">Log<span></span></a>
<ul>
<li class="active"><a href="namespace-Thelia.Log.Destination.html">Destination</a>
</li>
</ul></li>
<li><a href="namespace-Thelia.Model.html">Model<span></span></a>
<ul>
<li><a href="namespace-Thelia.Model.map.html">map</a>
</li>
<li><a href="namespace-Thelia.Model.om.html">om</a>
</li>
</ul></li>
<li><a href="namespace-Thelia.Routing.html">Routing<span></span></a>
<ul>
<li><a href="namespace-Thelia.Routing.Matcher.html">Matcher</a>
</li>
</ul></li>
<li><a href="namespace-Thelia.Tools.html">Tools</a>
</li>
<li><a href="namespace-Thelia.Tpex.html">Tpex<span></span></a>
<ul>
<li><a href="namespace-Thelia.Tpex.BaseParam.html">BaseParam</a>
</li>
<li><a href="namespace-Thelia.Tpex.Exception.html">Exception</a>
</li>
<li><a href="namespace-Thelia.Tpex.Loop.html">Loop</a>
</li>
<li><a href="namespace-Thelia.Tpex.Tests.html">Tests</a>
</li>
</ul></li></ul></li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-Thelia.Log.Destination.TlogDestinationFile.html">TlogDestinationFile</a></li>
<li><a href="class-Thelia.Log.Destination.TlogDestinationHtml.html">TlogDestinationHtml</a></li>
<li><a href="class-Thelia.Log.Destination.TlogDestinationNull.html">TlogDestinationNull</a></li>
<li><a href="class-Thelia.Log.Destination.TlogDestinationText.html">TlogDestinationText</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="namespace-Thelia.Log.Destination.html" title="Summary of Thelia\Log\Destination"><span>Namespace</span></a>
</li>
<li>
<a href="class-Thelia.Log.Destination.TlogDestinationFile.html" title="Summary of Thelia\Log\Destination\TlogDestinationFile"><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">/* */</span>
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment">/* Thelia */</span>
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">/* */</span>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/* Copyright (c) OpenStudio */</span>
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment">/* email : info@thelia.net */</span>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment">/* web : http://www.thelia.net */</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">/* This program is free software; you can redistribute it and/or modify */</span>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/* it under the terms of the GNU General Public License as published by */</span>
</span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">/* the Free Software Foundation; either version 3 of the License */</span>
</span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">/* */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment">/* This program is distributed in the hope that it will be useful, */</span>
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment">/* but WITHOUT ANY WARRANTY; without even the implied warranty of */</span>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */</span>
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment">/* GNU General Public License for more details. */</span>
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment">/* */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment">/* You should have received a copy of the GNU General Public License */</span>
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment">/* along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;. */</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">/*************************************************************************************/</span>
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">namespace</span> Thelia\<span class="php-keyword2">Log</span>\Destination;
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-keyword1">use</span> Thelia\<span class="php-keyword2">Log</span>\AbstractTlogDestination;
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-keyword1">use</span> Thelia\<span class="php-keyword2">Log</span>\TlogDestinationConfig;
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="TlogDestinationFile" href="#TlogDestinationFile">TlogDestinationFile</a> <span class="php-keyword1">extends</span> AbstractTlogDestination
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>{
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a> <span class="php-comment">// Nom des variables de configuration</span>
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> <span class="php-comment">// ----------------------------------</span>
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a> <span class="php-keyword1">const</span> <a id="VAR_PATH_FILE" href="#VAR_PATH_FILE">VAR_PATH_FILE</a> = <span class="php-quote">&quot;tlog_destinationfile_path&quot;</span>;
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-keyword1">const</span> <a id="TLOG_DEFAULT_NAME" href="#TLOG_DEFAULT_NAME">TLOG_DEFAULT_NAME</a> = <span class="php-quote">&quot;log-thelia.txt&quot;</span>;
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a> <span class="php-keyword1">const</span> <a id="VAR_MODE" href="#VAR_MODE">VAR_MODE</a> = <span class="php-quote">&quot;tlog_destinationfile_mode&quot;</span>;
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-keyword1">const</span> <a id="VALEUR_MODE_DEFAULT" href="#VALEUR_MODE_DEFAULT">VALEUR_MODE_DEFAULT</a> = <span class="php-quote">&quot;A&quot;</span>;
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$path_defaut" href="#$path_defaut">$path_defaut</a></span> = <span class="php-keyword1">false</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="$fh" href="#$fh">$fh</a></span> = <span class="php-keyword1">false</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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>()
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> {
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-var">$this</span>-&gt;path_defaut = THELIA_ROOT . <span class="php-quote">&quot;log/&quot;</span> . self::TLOG_DEFAULT_NAME;
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a> parent::__construct();
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> }
</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="_configure" href="#_configure">configure</a>()
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> {
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> <span class="php-var">$file_path</span> = <span class="php-var">$this</span>-&gt;getConfig(self::VAR_PATH_FILE);
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-var">$mode</span> = <span class="php-keyword2">strtolower</span>(<span class="php-var">$this</span>-&gt;getConfig(self::VAR_MODE)) == <span class="php-quote">'a'</span> ? <span class="php-quote">'a'</span> : <span class="php-quote">'w'</span>;
</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 class="php-keyword1">if</span> (! <span class="php-keyword1">empty</span>(<span class="php-var">$file_path</span>)) {
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-keyword1">if</span> (! <span class="php-keyword2">is_file</span>(<span class="php-var">$file_path</span>)) {
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-var">$dir</span> = <span class="php-keyword2">dirname</span>(<span class="php-var">$file_path</span>);
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-keyword1">if</span> (! <span class="php-keyword2">is_dir</span>(<span class="php-var">$dir</span>)) {
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword2">mkdir</span>(<span class="php-var">$dir</span>, <span class="php-num">0777</span>, <span class="php-keyword1">true</span>);
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> }
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a>
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-keyword2">touch</span>(<span class="php-var">$file_path</span>);
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-keyword2">chmod</span>(<span class="php-var">$file_path</span>, <span class="php-num">0777</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><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;fh) @<span class="php-keyword2">fclose</span>(<span class="php-var">$this</span>-&gt;fh);
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-var">$this</span>-&gt;fh = <span class="php-keyword2">fopen</span>(<span class="php-var">$file_path</span>, <span class="php-var">$mode</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><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 class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getTitle" href="#_getTitle">getTitle</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-keyword1">return</span> <span class="php-quote">&quot;Text File&quot;</span>;
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> }
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a>
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getDescription" href="#_getDescription">getDescription</a>()
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> {
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">return</span> <span class="php-quote">&quot;Store logs into text file&quot;</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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getConfigs" href="#_getConfigs">getConfigs</a>()
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> {
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">array</span>(
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-keyword1">new</span> TlogDestinationConfig(
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> self::VAR_PATH_FILE,
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-quote">&quot;Chemin du fichier&quot;</span>,
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-quote">&quot;Attention, vous devez indiquer un chemin absolu.&lt;br /&gt;Le répertoire de base de votre Thelia est &quot;</span>.<span class="php-keyword2">dirname</span>(<span class="php-keyword2">getcwd</span>()),
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-var">$this</span>-&gt;path_defaut,
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> TlogDestinationConfig::TYPE_TEXTFIELD
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> ),
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-keyword1">new</span> TlogDestinationConfig(
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> self::VAR_MODE,
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> <span class="php-quote">&quot;Mode d'ouverture (A ou E)&quot;</span>,
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-quote">&quot;Indiquez E pour ré-initialiser le fichier à chaque requête, A pour ne jamais réinitialiser le fichier. Pensez à le vider de temps en temps !&quot;</span>,
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> self::VALEUR_MODE_DEFAULT,
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> TlogDestinationConfig::TYPE_TEXTFIELD
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> )
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> );
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> }
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a>
</span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add" href="#_add">add</a>(<span class="php-var">$texte</span>)
</span><span id="101" class="l"><a class="l" href="#101">101: </a> {
</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;fh) {
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword2">fwrite</span>(<span class="php-var">$this</span>-&gt;fh, <span class="php-var">$texte</span>.<span class="php-quote">&quot;\n&quot;</span>);
</span><span id="104" class="l"><a class="l" href="#104">104: </a> }
</span><span id="105" class="l"><a class="l" href="#105">105: </a> }
</span><span id="106" class="l"><a class="l" href="#106">106: </a>
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_write" href="#_write">write</a>(&amp;<span class="php-var">$res</span>)
</span><span id="108" class="l"><a class="l" href="#108">108: </a> {
</span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;fh) @<span class="php-keyword2">fclose</span>(<span class="php-var">$this</span>-&gt;fh);
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-var">$this</span>-&gt;fh = <span class="php-keyword1">false</span>;
</span><span id="112" class="l"><a class="l" href="#112">112: </a> }
</span><span id="113" class="l"><a class="l" href="#113">113: </a>}
</span><span id="114" class="l"><a class="l" href="#114">114: </a></span></code></pre>
<div id="footer">
thelia API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>