Gumbo_Interface_Settings





	
Settings Interface
	
A Settings Class can hold any number of Setting objects.  Each Setting will be  required to have a key associated with it.  This will allow the program  to access particular Setting Objects thru a key reference.







	
	
	

	
	
	
	
	
															
																
																
																
				
			
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 addSetting ( Gumbo_Interface_Setting $setting, string $key )
			[line 45]
		

		
		
Adds a setting, overwriting the original setting if exists
		
					
Parameter(s):

			
			

				
					
    
											
  • postcondition:  remove all non alpha-numeric (except underscores) characters from $key
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public Gumbo_Interface_Setting getSetting ( string $key )
			[line 72]
		

		
		
Returns a single Setting object based on the key
		
					
Parameter(s):

			
    
							
  • 
				(string) $key
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public Gumbo_Interface_Setting[] getSettings (  )
			[line 65]
		

		
		
Returns the list of all Settings
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isSetting ( string $key )
			[line 79]
		

		
		
Returns if a Setting exists
		
					
Parameter(s):

			
    
							
  • 
				(string) $key
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void removeSetting ( string $key )
			[line 51]
		

		
		
Removes a Setting
		
					
Parameter(s):

			
    
							
  • 
				(string) $key
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void resetSettings (  )
			[line 57]
		

		
		
Resets all Settings
		
				
					
    
											
  • postcondition:  clears all settings
    • 
										

				
				
		
				
		

		[ Top ]