Gumbo_Interface_Log





	
Log Interface
	
This is responsible for holding Log Message created by the system.  A Log  Message Type is defined by the Log Message, which indicates the type of Log  Message being created.  The implementing class will have the option to  restrict certain Message Types from being written.  This creates an easy way  to ignore certain types of Messages.







	
	
	

	
	
	
	
	
															
																
																
																
				
			
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 add (  $mess )
			[line 55]
		

		
		
Adds a log message to the list
		
					
Parameter(s):

			
    
							
  • 
				(Gumbo_Interface_Log_Message) $mess
								
    • 
						

			

				
					
    
											
  • precondition:  isOn()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void addType ( string $type )
			[line 78]
		

		
		
Adds an active Log Message Type
		
					
Parameter(s):

			
    
							
  • 
				(string) $type
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void clear (  )
			[line 60]
		

		
		
Clears the log messages in the system
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void delType ( string $type )
			[line 84]
		

		
		
Removes an active Log Message Type
		
					
Parameter(s):

			
    
							
  • 
				(string) $type
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public array getAll (  )
			[line 98]
		

		
		
Returns all the log messages
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public array getTypes (  )
			[line 110]
		

		
		
Returns all available types
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool ignoreTypes ( [bool $ignore] )
			[line 124]
		

		
		
Returns if to ignore Types (or set to ignore Types)
		
					
Parameter(s):

			
    
							
  • 
				(bool) $ignore
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isOn (  )
			[line 104]
		

		
		
Returns if Logging is on
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isType ( string $type )
			[line 117]
		

		
		
Returns if the message type is registered
		
					
Parameter(s):

			
    
							
  • 
				(string) $type
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void resetTypes (  )
			[line 89]
		

		
		
Resets the types
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void turnOff (  )
			[line 72]
		

		
		
Turn off Logging
		
				
					
    
											
  • postcondition:  !isOn()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void turnOn (  )
			[line 66]
		

		
		
Turn on Logging
		
				
					
    
											
  • postcondition:  isOn()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void write (  )
			[line 48]
		

		
		
Writes the messages to the corresponding Log file
		
				
					
    
											
  • precondition:  isOn()
    • 
										

				
				
		
				
		

		[ Top ]