ea-Geiercode-base
[ class tree: ea-Geier ] [ index: ea-Geier ] [ all elements ]

Class: eaInput

Source Location: /code/base/input.class.php

Class eaInput

Class Overview
Class Overview | Properties Summary | Properties Detail | Method Summary | Methods Detail

wrapper for user inpput

Located in /code/base/input.class.php [line 38] 



		
		
		
				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	







	
	

		
Property Summary

		

			Class Overview |
									Property Summary | Properties Detail
												Method Summary | Methods Detail
											    				

		

			

			

					

					

					

					

																																					
array  
					$error  
					errors for post or get vars

				
													
array  
					$get  
					validated get vars

				
													
array  
					$post  
					validated post vars

				
													
eaCheck  
					$_check  
					validator class

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

			Class Overview |
																		Properties Summary | Properties Detail
											    					Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

											

											

											

											

											

																																																																																																
eaInput  
										eaInput()  
					constructor

				
																
boolean  
										check()  
					validate input variables

				
																
boolean  
										createTestPattern()  
					create test pattern

				
																
mixed  
										get()  
					provides parsed $_GET variable

				
																
integer/boolean  
										getClient()  
					returns & sets current client

				
																
string/boolean  
										getGet()  
					looks for a get variable hidden in the url

				
																
string/boolean  
										getPage()  
					looks for a page variable hidden in the url or stored in session

				
																
string/boolean  
										getSort()  
					looks for a sort variable hidden in the url or stored in session

				
																
mixed  
										post()  
					provides parsed $_POST variable

				
																
boolean  
										setClient()  
					sets client manually

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

			Class Overview |
													Property Summary | Properties Detail
			
							|
									Method Summary | Methods Detail
												

		

			



	

		
			array  
			$error
			 =  false			[line 66]
		
	


	
errors for post or get vars


	

	
		

	
[ Top ]







	

		
			array  
			$get
			 =  false			[line 59]
		
	


	
validated get vars


	

	
		

	
[ Top ]







	

		
			array  
			$post
			 =  false			[line 52]
		
	


	
validated post vars


	

	
		

	
[ Top ]







	

		
			eaCheck  
			$_check
			 =  false			[line 45]
		
	


	
validator class


	

	
		

	
[ Top ]



		

	


	
	

		
Methods

		

			Class Overview |
									                |
									Property Summary | Properties Detail
																	| Method Summary | Methods Detail
					

		

			







	Constructor eaInput  [line 73]





	

    

    
 
		eaInput eaInput(
)
    

    



	
constructor



defines validator

	

	

		
		

	
[ Top ]









	check  [line 85]





	

    

    
 
		boolean check(
array/string
$dsn 
)
    

    



	
validate input variables



parses $_GET and $_POST according data definition

			Parameters:

			

					

				array/string  
				
				$dsn: 
				
				 data defnition			

				


	

	API Tags:



  

    Return:  status (existing variables)
  







		
		

	
[ Top ]









	createTestPattern  [line 138]





	

    

    
 
		boolean createTestPattern(
string
$dsn, array
&$pattern, array
&$test 
)
    

    



	
create test pattern



breaks data definition into valid parts  and generates a test array and a test pattern

			Parameters:

			

					

				string  
				
				$dsn: 
				
				 data definition			

					

				array  
				
				&$pattern: 
				
				 test pattern			

					

				array  
				
				&$test: 
				
				 test array			

				


	

	API Tags:



  

    Return:  status
  







		
		

	
[ Top ]









	get  [line 166]





	

    

    
 
		mixed get(
string
$var 
)
    

    



	
provides parsed $_GET variable



			Parameters:

			

					

				string  
				
				$var: 
				
				 variable name			

				


	

	API Tags:



  

    Return:  variable value | false (!exist | error)
  







		
		

	
[ Top ]









	getClient  [line 193]





	

    

    
 
		integer/boolean getClient(
eaDB
&$db 
)
    

    



	
returns & sets current client



The client is fetched either from the url or from the session.  The url overwrites the session.

			Parameters:

			

					

				eaDB  
				
				&$db: 
				
				 database			

				


	

	API Tags:



  

    Return:  clientId || false
  







		
		

	
[ Top ]









	getGet  [line 268]





	

    

    
 
		string/boolean getGet(
string
$what, [string
$type = 'num'] 
)
    

    



	
looks for a get variable hidden in the url



			Parameters:

			

					

				string  
				
				$what: 
				
				 variable			

					

				string  
				
				$type: 
				
				 type			

				


	

	API Tags:



  

    Return:  variable content || false
  







		
		

	
[ Top ]









	getPage  [line 330]





	

    

    
 
		string/boolean getPage(

$prefix 
)
    

    



	
looks for a page variable hidden in the url or stored in session



			Parameters:

			

					

				  
				
				$prefix: 
				
							

				


	

	API Tags:



  

    Return:  sort string || false
  







		
		

	
[ Top ]









	getSort  [line 294]





	

    

    
 
		string/boolean getSort(
[array
$allowed = false], [
$prefix = ''] 
)
    

    



	
looks for a sort variable hidden in the url or stored in session



			Parameters:

			

					

				array  
				
				$allowed: 
				
				 allowed sort variables			

					

				  
				
				$prefix: 
				
							

				


	

	API Tags:



  

    Return:  sort string || false
  







		
		

	
[ Top ]









	post  [line 178]





	

    

    
 
		mixed post(
string
$var 
)
    

    



	
provides parsed $_POST variable



			Parameters:

			

					

				string  
				
				$var: 
				
				 variable name			

				


	

	API Tags:



  

    Return:  variable value | false (!exist | error)
  







		
		

	
[ Top ]









	setClient  [line 252]





	

    

    
 
		boolean setClient(
[integer
$id = false] 
)
    

    



	
sets client manually



			Parameters:

			

					

				integer  
				
				$id: 
				
				 clientID			

				


	

	API Tags:



  

    Return:  status
  







		
		

	
[ Top ]



		

	



        

		    

		    Documentation generated on Sun, 09 Sep 2007 17:08:55 +0200 by phpDocumentor 1.3.1