Gumbo_Debug_Message





	
Debug Message Class
	







	
	
	

	
	
	
	
	
															
																
																
																
				
			
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

		







	
Implements interfaces:

	
	





	


	



	
	
Class Variables

	
	
	

		string $_class		[line 47] 
		
		
			

	
	
	

		string $_file		[line 45] 
		
		
			

	
	
	

		string $_function		[line 49] 
		
		
			

	
	
	

		int $_line		[line 43] 
		
		
			

	
	
	

		string $_message		[line 52] 
		
		
			

	
	
	

		num $_seconds =  0		[line 40] 
		
		
			

	
	
	

		num $_time		[line 38] 
		
		
			

	
	


	
	
Class Methods

	


	
	
	

		

			public Gumbo_Debug_Message __construct ( string $mess, string $file, int $line, [string $func], [string $cls] )
			[line 64]
		

		
		
Constructor
		
					
Parameter(s):

			
    
							
  • 
				(string) $mess
				 :: message				
    • 
							
  • 
				(string) $file
				 :: file name __FILE__				
    • 
							
  • 
				(int) $line
				 :: line number __LINE__				
    • 
							
  • 
				(string) $func
				 :: function/method name __FUNCTION__				
    • 
							
  • 
				(string) $cls
				 :: class name __CLASS__				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public string getClass (  )
			[line 284]
		

		
		
Returns the class name
		
				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::getClass()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public string getFile (  )
			[line 260]
		

		
		
Returns the file
		
				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::getFile()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public string getFunction (  )
			[line 276]
		

		
		
Returns the function/method
		
				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::getFunction()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public int getLine (  )
			[line 268]
		

		
		
Returns the line number
		
				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::getLine()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public string getMessage (  )
			[line 252]
		

		
		
Returns the message
		
				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::getMessage()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public num getSeconds ( [num $time] )
			[line 293]
		

		
		
Returns the time (in seconds) it took to execute the code from last message
		
					
Parameter(s):

			
    
							
  • 
				(num) $time
				 :: last message time stamp				
    • 
						

			

				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::getSeconds()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public num getTime (  )
			[line 244]
		

		
		
Returns the time when message occured
		
				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::getTime()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public void setClass ( string $cls )
			[line 196]
		

		
		
Sets the class name
		
					
Parameter(s):

			
    
							
  • 
				(string) $cls
								
    • 
						

			

				
					
    
											
  • throws:  Gumbo_Exception
    • 
										

				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::setClass()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public void setFile ( string $file )
			[line 125]
		

		
		
Sets the file where the message occured
		
					
Parameter(s):

			
    
							
  • 
				(string) $file
								
    • 
						

			

				
					
    
											
  • precondition:  file_exists ($file)
    • 
											
  • throws:  Gumbo_Exception
    • 
										

				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::setFile()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public void setFunction ( string $func )
			[line 170]
		

		
		
Sets the function/method name
		
					
Parameter(s):

			
    
							
  • 
				(string) $func
								
    • 
						

			

				
					
    
											
  • precondition:  function_exists ($func)
    • 
											
  • throws:  Gumbo_Exception
    • 
										

				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::setFunction()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public void setLine ( int $line )
			[line 147]
		

		
		
Sets the line number of the message
		
					
Parameter(s):

			
    
							
  • 
				(int) $line
								
    • 
						

			

				
					
    
											
  • throws:  Gumbo_Exception
    • 
										

				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::setLine()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public void setMessage ( string $mess )
			[line 105]
		

		
		
Sets the message contents of the message
		
					
Parameter(s):

			
    
							
  • 
				(string) $mess
								
    • 
						

			

				
					
    
											
  • throws:  Gumbo_Exception
    • 
										

				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::setMessage()

					
				
		

		[ Top ]
	

	
	
	
	

		

			public void setSeconds ( [num $time] )
			[line 220]
		

		
		
Sets the time (in seconds) to get to debug message from last message
		
					
Parameter(s):

			
    
							
  • 
				(num) $time
								
    • 
						

			

				
				
				
					

			
Implementation of:

							
Gumbo_Interface_Debug_Message::setSeconds()

					
				
		

		[ Top ]
	

	
	
	
	

		

			private void _setTime ( num $time )
			[line 86]
		

		
		
Sets the time stamp when the message was created
		
					
Parameter(s):

			
    
							
  • 
				(num) $time
								
    • 
						

			

				
					
    
											
  • throws:  Gumbo_Exception
    • 
										

				
				
		
				
		

		[ Top ]