https://www.verzauberte-welten.de/index.php?action=history&feed=atom&title=Modul%3ADebug%2Fclass%2Fdoc 2026-04-05T23:45:24Z Versionsgeschichte dieser Seite in Verzauberte Welten e.V. MediaWiki 1.39.8 https://www.verzauberte-welten.de/index.php?title=Modul:Debug/class/doc&diff=4414&oldid=prev 2015-12-23T21:59:49Z

<p></p> <p><b>Neue Seite</b></p><div>{{documentation subpage}}<br /> {{module rating|beta}}<br /> &lt;!-- Categories go at the bottom of this page and interwikis go in Wikidata. --&gt;<br /> <br /> This is a Class Module. It implements a class in Lua using [[Module:Middleclass]]. This class provides methods for creating and printing a debug log.<br /> <br /> == Usage ==<br /> <br /> {{code|lang=lua|code=<br /> local classDebug = require('Module:Debug/class')<br /> local debugObject = classDebug:new('handlername')<br /> debugObject:methodcall()<br /> classDebug:staticMethodcall()<br /> }}<br /> <br /> To use the debug log, create an object and provide a (unique) handler. Then log things via [[#log(level, text)|log(level, text)]] or [[#classDebug:log(level, text, handler)|classDebug:log(level, text, handler)]]. At any time, you can print the log. When doing so, you can either<br /> * print the whole debug log (over all available handlers)<br /> * or only your specific handler<br /> <br /> This class uses a static property to create the debug log, meaning all instances of class debug (all objects) write in one log (ie. a table). Later - depending whether you use the public or the static method - you print only 'your' entries (the one using your handler) or the whole log.<br /> <br /> Besides a handler, all entries have a timestamp and a loglevel. On printout, all entries with a loglevel higher than a given number will be ommited.<br /> <br /> == Constructor ==<br /> === new(handler) ===<br /> Creates a new Object for class debug.<br /> ;handler<br /> :string, mandatory<br /> :identifies your entries. should be unique over all used handlers/objects<br /> ;return<br /> :object, of class debug<br /> <br /> == Methods ==<br /> === Public methods ===<br /> <br /> ==== __tostring() ====<br /> Returns a string representation of your debug log (all entries identified by your handler). Uses default debug level and default outputtype.<br /> {{small|<br /> ;return<br /> :string, representation of itself<br /> }}<br /> <br /> ==== log(level, text) ====<br /> Creates a log entry.<br /> {{small|<br /> ;level<br /> :integer, mandatory<br /> :defines the log-level of the entry. the lower, the more important.<br /> ;text<br /> :string, mandatory<br /> :the actual log entry<br /> ;return<br /> :void<br /> }}<br /> <br /> ==== printLog(level, outputtype) ====<br /> Prints all log entries having the same handler as this specific object. Not provided parameters will be defaulted. See [[#static|static properties]].<br /> {{small|<br /> ;level<br /> :integer, suggested<br /> :specifies which log entries will be printed in the log. all entries with a level higher than this number will be omitted.<br /> ;outputtype<br /> :string, suggested<br /> :formats the log. supported types are 'plain', 'ol', 'ul', 'pre'<br /> ;return<br /> :string, formatted and filtered debug log<br /> }}<br /> <br /> === Static methods ===<br /> <br /> ==== classDebug:log(level, text, handler) ====<br /> Creates a log entry. Can be called by other (static) methods without having a debug object at hand.<br /> {{small|<br /> ;level<br /> :integer, mandatory<br /> :defines the log-level of the entry. the lower, the more important.<br /> ;text<br /> :string, mandatory<br /> :the actual log entry<br /> ;handler<br /> :string, suggested<br /> :helps to identify the log entry. works just like the handler you create when [[#new(handler)|instanciating an object of this class]]<br /> ;return<br /> :void<br /> }}<br /> <br /> ==== classDebug:printLog(level, outputtype) ====<br /> Prints all log entries (effectively doing the same as the public method [[#printLog(level, outputtype)|printLog(level, outputtype)]] only without the handler restriction). Not provided parameters will be defaulted. See [[#static|static properties]]<br /> {{small|<br /> ;level<br /> :integer, suggested<br /> :specifies which log entries will be printed in the log. all entries with a level higher than this number will be omitted.<br /> ;outputtype<br /> :string, suggested<br /> :formats the log. supported types are 'plain', 'ol', 'ul', 'pre'<br /> ;return<br /> :string, formatted and filtered debug log<br /> }}<br /> <br /> === Private methods ===<br /> none<br /> <br /> == Properties ==<br /> <br /> === static ===<br /> <br /> ;_debugLog<br /> :table, holds all debug entries<br /> ;_defaultDebugLevel<br /> :integer, default log level for printLog methods if none is provided<br /> ;_defaultOutputType<br /> :string, default output format for printLog methods if none is provided<br /> ;_LANG<br /> :object, mw.language.new( 'de' ) used for timestamp format in debug log<br /> <br /> <br /> === private ===<br /> Note: all private properties are stored in table ''_private[self]''. _private is a static array that is indexed by ''self'', so the table ''_private[self]'' holds all properties for instance ''self''.<br /> ;handler<br /> :'my' log entry handler with which this object marks all entries it loggs.<br /> <br /> <br /> <br /> [[Category:Class engine]]&lt;includeonly&gt;{{#ifeq:{{SUBPAGENAME}}|sandbox||<br /> &lt;!-- Categories go here if you wish an additional category to that set in {{module rating}} above automatically. --&gt;<br /> [[Category:Lua metamodules]] [[Category:Lua class modules]]<br /> }}&lt;/includeonly&gt;</div>

imported>Oetterer