Gumbo_Interface_Error





	
Error Interface
	
The Error Interface is responsible for holding a lit of all the Errors  thrown by the program.  This allows the program to have a central location  for getting all the Errors that have occured.
The Report Level is the minimum level of Errors that will be reported.  All Errors  will be saved, however only the Errors at or above the Report Level will be  displayed.
The Ignore Level is the maximum level of Errors that will be ignored.  The idea  is to have the Error handler ignore certain Errors thrown.  Any Errors at or  below the ignore level should be thrown out.







	
	
	

	
	
	
	
	
															
																
																
																
				
			
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 (  $e )
			[line 52]
		

		
		
Adds an Exception to the list
		
					
Parameter(s):

			
    
							
  • 
				(Exception) $e
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void clear ( [int $level] )
			[line 58]
		

		
		
Clears all the errors from the system
		
					
Parameter(s):

			
    
							
  • 
				(int) $level
				 :: level to clear				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public int count ( [int $level] )
			[line 110]
		

		
		
Returns the number of errors
		
					
Parameter(s):

			
    
							
  • 
				(int) $level
				 :: number of errors at level				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool exists ( [int $level] )
			[line 91]
		

		
		
Returns if any Errors exist
		
					
Parameter(s):

			
    
							
  • 
				(int) $level
				 :: if errors of this level exist				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public Exception[] getAll ( [int $level], [bool $only] )
			[line 84]
		

		
		
Returns all Errors
		
					
Parameter(s):

			
    
							
  • 
				(int) $level
				 :: limit to supplied level and above				
    • 
							
  • 
				(bool) $only
				 :: limits to only errors at the supplied level				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public int getIgnoreLevel (  )
			[line 122]
		

		
		
Returns the minimum ignore level
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public int getReportLevel (  )
			[line 116]
		

		
		
Returns the minimum reporting level
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public int level (  )
			[line 103]
		

		
		
Returns the current error level value
The Error level will be a base 2 int representation of the  available error level constants.  This will allow the system  to determine the level of errors triggered during program  execution.
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setIgnoreLevel ( int $level )
			[line 73]
		

		
		
Sets the ignore level (inclusive and below)
		
					
Parameter(s):

			
    
							
  • 
				(int) $level
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setReportLevel ( int $level )
			[line 67]
		

		
		
Sets the minimum error reporting level (inclusive and above)
		
					
Parameter(s):

			
    
							
  • 
				(int) $level
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]