debugConsole_1.2.0
[ class tree: debugConsole_1.2.0 ] [ index: debugConsole_1.2.0 ] [ all elements ]
Packages:
debugConsole_1.2.0


Files:
debugConsole.class.php
debugConsole.config.php
debugConsole.functions.php
debugConsole.php
example.php

Classes:
debugConsole

Class: debugConsole

Source Location: /debugConsole.class.php

Class Overview




debugConsole class




Author(s):






    
            

Version:


    
  
  • 1.2.0
    • 








Variables







Methods
























Class Details



[line 13]

debugConsole class

This class allows opening an external JavaScript  window for debugging purposes.





Tags:





  

    version:  1.2.0
  

  

    see:  <http://www.debugconsole.de>
  

  

    author:  Andreas Demmer <info@debugconsole.de>
  










[ Top ]







Class Variables



	
	

	
$config = 

	
[line 33]

  debugConsole configuration values





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$filters = 

	
[line 19]

  events which are shown in debug console





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$html = 

	
[line 54]

  html for popup





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$javascripts = 

	
[line 47]

  javascripts to control popup





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$starttime = 

	
[line 61]

  time of debugrun start in milliseconds





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$template = 

	
[line 40]

  URL where template can be found





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$timers = 

	
[line 68]

  time of timer start in milliseconds





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$watches = 

	
[line 26]

  all watched variables with their current content





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 73]

	

    

    

		debugConsole __construct(
)
    

    


	
		constructor, opens popup window





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
destructor __destruct [line 103]

	

    

    

		void __destruct(
)
    

    


	
		destructor, shows runtime and finishes html document in popup window





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method cropScriptPath [line 462]

	

    

    

		string cropScriptPath(
string
$path, [int
$maxLength = 30])
    

    


	
		crops long script path, shows only the last $maxLength chars





Tags:





  

    access:  protected
  










        
Parameters:

    

    

          

        string  
        $path  
        
      

          

        int  
        $maxLength  
        
      

        

    


        
[ Top ]

  

  

	
	
method dump [line 310]

	

    

    

		void dump(
mixed
$variable, string
$text)
    

    


	
		show debug info for variable in debugConsole,  added by custom text for documentation and hints





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        mixed  
        $variable  
        
      

          

        string  
        $text  
        
      

        

    


        
[ Top ]

  

  

	
	
method errorHandlerCallback [line 347]

	

    

    

		void errorHandlerCallback(
)
    

    


	
		callback method for PHP errorhandling





Tags:





  

    access:  public
  

  

    todo:  implement more errorlevels
  










        
[ Top ]

  

  

	
	
method getFilters [line 275]

	

    

    

		array getFilters(
)
    

    


	
		returns all possible filter events for debugConsole::setFilter() method





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMicrotime [line 265]

	

    

    

		float getMicrotime(
)
    

    


	
		returns microtime as float value





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method getTraceback [line 430]

	

    

    

		string getTraceback(
)
    

    


	
		returns a formatted traceback string





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method passedCheckpoint [line 249]

	

    

    

		void passedCheckpoint(
[string
$message = NULL])
    

    


	
		shows in console that a checkpoint has been passed,  additional info is the file and line which triggered  the output





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $message  
        
      

        

    


        
[ Top ]

  

  

	
	
method sendCommand [line 186]

	

    

    

		void sendCommand(
string
$command, [string
$value = FALSE])
    

    


	
		sends a javascript command to browser





Tags:





  

    access:  protected
  










        
Parameters:

    

    

          

        string  
        $command  
        
      

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setFilter [line 292]

	

    

    

		bool setFilter(
string
$event, bool
$isShown)
    

    


	
		shows or hides an event-type in debugConsole,  returns previous setting of the given event-type





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $event  
        
      

          

        bool  
        $isShown  
        
      

        

    


        
[ Top ]

  

  

	
	
method startDebugRun [line 123]

	

    

    

		void startDebugRun(
)
    

    


	
		show new debug run header in console





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method startTimer [line 382]

	

    

    

		mixed startTimer(
string
$comment)
    

    


	
		start timer clock, returns timer handle





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $comment  
        
      

        

    


        
[ Top ]

  

  

	
	
method stopTimer [line 403]

	

    

    

		bool stopTimer(
string
$timerHandle)
    

    


	
		stop timer clock





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $timerHandle  
        
      

        

    


        
[ Top ]

  

  

	
	
method watchesCallback [line 161]

	

    

    

		void watchesCallback(
)
    

    


	
		tick callback: process watches and show changes





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method watchVariable [line 141]

	

    

    

		void watchVariable(
string
$variableName)
    

    


	
		adds a variable to the watchlist

Watched variables must be in a declare(ticks=n)  block so that every n ticks the watched variables  are checked for changes. If any changes were made,  the new value of the variable is shown in the  debugConsole with additional information where the  changes happened.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $variableName  
        
      

        

    


        
[ Top ]

  

  

	
	
method writeLogfileEntry [line 217]

	

    

    

		void writeLogfileEntry(
string
$command, string
$value)
    

    


	
		writes html output as text entry into logfile





Tags:





  

    access:  protected
  










        
Parameters:

    

    

          

        string  
        $command  
        
      

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Fri, 18 Nov 2005 12:40:00 +0100 by phpDocumentor 1.3.0RC3