Gumbo_Interface_Debug





	
Debug Interface
	







	
	
	

	
	
	
	
	
															
																
																
																
				
			
Author(s):
												Michael Luster <mluster79@yahoo.com>

																																					

		
			
License:New BSD License

		
			
Copyright:Copyright (c) 2007, iBayou, Michael Luster

		
			
Link:http://sourceforge.net/projects/phpgumbo

		
			
Version:0.0.1

		











	


	




	
	
Interface Methods

	


	
	
	

		

			public void activate (  )
			[line 93]
		

		
		
Activates the Debugger
		
				
					
    
											
  • postcondition:  $_active = true
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void add ( string $mess, string $file, int $line, [string $func], [string $cls] )
			[line 44]
		

		
		
Creates a message and adds it to the Debugger
		
					
Parameter(s):

			
    
							
  • 
				(string) $mess
				 :: message content				
    • 
							
  • 
				(string) $file
				 :: file name				
    • 
							
  • 
				(int) $line
				 :: line number				
    • 
							
  • 
				(string) $func
				 :: function/method name				
    • 
							
  • 
				(string) $cls
				 :: class name				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void addRestrictedClass ( string $cls )
			[line 61]
		

		
		
Adds a class to the restriction list
		
					
Parameter(s):

			
    
							
  • 
				(string) $cls
				 :: class name				
    • 
						

			

				
					
    
											
  • precondition:  !isRestrictedClass ($cls)
    • 
											
  • precondition:  is_class ($cls)
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void addRestrictedFile ( string $file, [int $start], [int $end] )
			[line 72]
		

		
		
Adds a file to the restriction list
		
					
Parameter(s):

			
    
							
  • 
				(string) $file
				 :: file name				
    • 
							
  • 
				(int) $start
				 :: start line				
    • 
							
  • 
				(int) $end
				 :: end line				
    • 
						

			

				
					
    
											
  • precondition:  file_exists ($file)
    • 
											
  • precondition:  $start < $end
    • 
											
  • precondition:  !isRestrictedFile ($file, $start, $end)
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void addRestrictedFunction ( string $func, [string $cls] )
			[line 53]
		

		
		
Adds a function to the restriction list
		
					
Parameter(s):

			
    
							
  • 
				(string) $func
				 :: function name				
    • 
							
  • 
				(string) $cls
				 :: class name				
    • 
						

			

				
					
    
											
  • precondition:  !isRestrictedFunction ($func, $cls)
    • 
											
  • precondition:  function_exists ($func) or method_exists ($cls, $func)
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void deactivate (  )
			[line 99]
		

		
		
Deactivates the Debugger
		
				
					
    
											
  • postcondition:  $_active = false
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public array getAllMessages (  )
			[line 123]
		

		
		
Returns all the messages of the Debugger
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public num getTime (  )
			[line 129]
		

		
		
Returns the time stamp when the Debugger was started
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isActive (  )
			[line 137]
		

		
		
Returns if the Debug mode is active
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isInclusive (  )
			[line 143]
		

		
		
Returns if the restrictions are inclusive
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isRestrictedClass ( string $cls )
			[line 158]
		

		
		
Returns if the class is restricted
		
					
Parameter(s):

			
    
							
  • 
				(string) $cls
				 :: class name				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isRestrictedFile ( string $file, [int $line] )
			[line 166]
		

		
		
Returns if the file is restricted
		
					
Parameter(s):

			
    
							
  • 
				(string) $file
				 :: file name				
    • 
							
  • 
				(int) $line
				 :: line number				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isRestrictedFunction ( string $func, [string $cls] )
			[line 151]
		

		
		
Returns if the function is restricted
		
					
Parameter(s):

			
    
							
  • 
				(string) $func
				 :: function name				
    • 
							
  • 
				(string) $cls
				 :: class name				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void reset (  )
			[line 87]
		

		
		
Resets the Debug messages
		
				
					
    
											
  • postcondition:  $_messages = array ()
    • 
											
  • postcondition:  setTime ()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void resetRestrictions (  )
			[line 80]
		

		
		
Resets all the restrictions
		
				
					
    
											
  • postcondition:  $_functions, $_classes, $_files = array ()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setExclusive (  )
			[line 114]
		

		
		
Sets the mode to Exclusive
		
				
					
    
											
  • postcondition:  $_inclusive = false
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setInclusive (  )
			[line 108]
		

		
		
Set the mode to Inclusive
		
				
					
    
											
  • postcondition:  $_inclusive = true
    • 
										

				
				
		
				
		

		[ Top ]