dftk
[ class tree: dftk ] [ index: dftk ] [ all elements ]

Class: DftkDaTraceManager

Source Location: /trace/dftk_da_trace_manager.php

Class Overview


DFTK Trace Manager Class


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 45]
DFTK Trace Manager Class



Tags:

access:  public
author:  Duck <mailto:duck@DuckCorp.org>


[ Top ]


Class Methods


constructor DftkDaTraceManager [line 93]

DftkDaTraceManager DftkDaTraceManager( object DftkDaLanguageManager &$lm)

Constructor



Tags:

access:  public


Parameters:

object DftkDaLanguageManager   &$lm   Language Manager

[ Top ]

method create_trace [line 435]

object DftkDaTrace &create_trace( )

Creste a new Trace attached to this Manager



Tags:

return:  Created Trace
access:  public


[ Top ]

method get_event_infos [line 281]

array get_event_infos( string $key)

Get event information

Event information fields :

  • modules : module name in which the event is registered
  • section : section name in which the event is registered
  • severity : event severity
List of severities :
  • E : error
  • W : warning
  • N : notice




Tags:

return:  Information about event (or false if event not existing)
access:  public


Parameters:

string   $key   Event Id

[ Top ]

method get_event_list [line 353]

array get_event_list( )

Get a list of registered events



Tags:

return:  List of registered events
access:  public


[ Top ]

method get_event_msg_template [line 313]

string get_event_msg_template( string $key)

Get the event message template



Tags:

return:  Message template (or false if event not existing)
access:  public


Parameters:

string   $key   Event Id

[ Top ]

method get_language_manager [line 342]

object DftkDaLanguageManager &get_language_manager( )

Get the selected Language Manage



Tags:

return:  Language Manage
access:  public


[ Top ]

method get_module_list [line 368]

array get_module_list( )

Get a list of existing modules



Tags:

return:  List of existing modules
access:  public


[ Top ]

method get_section_list [line 399]

array get_section_list( mixed $module)

Get a list of existing sections



Tags:

return:  List of existing sections
access:  public


[ Top ]

method has_output [line 121]

boolean has_output( )

Has Output ?



Tags:

return:  true if Output defined
access:  public


[ Top ]

method is_event [line 328]

boolean is_event( string $key)

Test if a key is an event Id



Tags:

return:  true if the key is an event Id
access:  public


Parameters:

string   $key   Event Id

[ Top ]

method is_module [line 384]

boolean is_module( string $module)

Test if a string is a module name



Tags:

return:  true if the string is a module name
access:  public


Parameters:

string   $module   Module name

[ Top ]

method is_section [line 417]

boolean is_section( mixed $module, string $section)

Test if a string is a section name



Tags:

return:  true if the string is a section name
access:  public


Parameters:

string   $section   Section name

[ Top ]

method register_events [line 186]

boolean register_events( string $module, string $dir)

Register events



Tags:

return:  true if registration was successful
access:  public


Parameters:

string   $module   Module name
string   $dir   Directory path where to find traces information

[ Top ]

method register_traces [line 173]

boolean register_traces( string $module, string $dir)

Register traces



Tags:

return:  true if registration was successful
deprecated:  Use 'register_events' instead, this was a confusing method name.
access:  public


Parameters:

string   $module   Module name
string   $dir   Directory path where to find traces information

[ Top ]

method reload [line 149]

boolean reload( )

Rebuild the list of events and the modules/sections tree



Tags:

return:  true if reload was successful
access:  public


[ Top ]

method set_output [line 110]

void set_output( object DftkOutput &$output)

Set Output

Set output to 'null' if no output wanted (default).




Tags:

access:  public


Parameters:

object DftkOutput   $output   Output object

[ Top ]


Documentation generated on Sat, 6 Dec 2003 13:47:36 +0100 by phpDocumentor 1.2.3