Gumbo_Interface_Input





	
Input 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 addConstraint ( Gumbo_Interface_Constraint $obj )
			[line 51]
		

		
		
Adds a Constraint against the Data (additional arguments accepted for Constraint parameters)
		
					
Parameter(s):

			
			

				
					
    
											
  • postcondition:  !isClean()
    • 
											
  • postcondition:  !isChecked()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void addReturnConstraint ( Gumbo_Interface_Constraint $obj )
			[line 59]
		

		
		
Adds a return Constraint, which returns a formatted value
		
					
Parameter(s):

			
			

				
					
    
											
  • postcondition:  !isClean()
    • 
											
  • postcondition:  !isChecked()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool clean (  )
			[line 43]
		

		
		
Cleans the Data by running through the Constraints
		
				
					
    
											
  • precondition:  !isChecked()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public Gumbo_Interface_Constraint[] getConstraints (  )
			[line 100]
		

		
		
Returns ALL the Constraints
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public mixed getData ( [bool $raw] )
			[line 94]
		

		
		
Returns the Data
		
					
Parameter(s):

			
    
							
  • 
				(bool) $raw
				 :: as raw data				
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isChecked (  )
			[line 112]
		

		
		
Returns if the Data was checked
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isClean (  )
			[line 106]
		

		
		
Returns if the Data is clean
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void resetConstraints (  )
			[line 67]
		

		
		
Resets ALL Constraints
		
				
					
    
											
  • postcondition:  !getConstraints()
    • 
											
  • postcondition:  !isChecked()
    • 
											
  • postcondition:  !isClean()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setData ( mixed $data )
			[line 78]
		

		
		
Sets the input data
		
					
Parameter(s):

			
    
							
  • 
				(mixed) $data
								
    • 
						

			

				
					
    
											
  • postcondition:  !isClean()
    • 
											
  • postcondition:  !isChecked()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setRunThru ( bool $val )
			[line 84]
		

		
		
Sets if ALL Exceptions should be caught, or stop at first Exception
		
					
Parameter(s):

			
    
							
  • 
				(bool) $val
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool toRunThru (  )
			[line 118]
		

		
		
Returns if all Exceptions should be caught, or stop at first Exception
		
				
				
				
		
				
		

		[ Top ]