Class JSQuickWalk

Description
Description | Vars (details) | Methods (details)

Create a pair of forward/back javascript links to allow the user to move forward and back through a sequence of date periods

Located in /inc/jsquickwalk.php (line 26) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

																																																																

					string
					$back
				

																

					integer
					$counter
				

																

					string
					$fwd
				

																

					array
					$keys
				

																

					string
					$namebase
				

																

					array
					$values
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																																				
												

											JSQuickWalk
										JSQuickWalk
											(string $namebase, string $back, string $fwd, array $keys, array $values, integer $counter)
									

																

											string
										displayBack
										()
									

																

											string
										displayFwd
										()
									

																

											string
										displayJS
										()
									

								

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			string
			$back
						(line 36)
		
	


	

name for the "back" link

	
	
		
		







	

		
			integer
			$counter
						(line 56)
		
	


	

initial position in sequence

	
	
		
		







	

		
			string
			$fwd
						(line 41)
		
	


	

name for the "forward" link

	
	
		
		







	

		
			array
			$keys
						(line 46)
		
	


	

html text-input id's for the two date elements

	
	
		
		







	

		
			string
			$namebase
						(line 31)
		
	


	

unqiue name in the javascript namespace for these functions (prepended to everything)

	
	
		
		







	

		
			array
			$values
						(line 51)
		
	


	

dates to use in the sequence

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			




	
	

		Constructor JSQuickWalk (line 67)
	
 
	
	

Constructor

	
	

		JSQuickWalk
		
			JSQuickWalk
		
					(string $namebase, string $back, string $fwd, array $keys, array $values, integer $counter)
			

	
			
    
					
  • 
				string
				$namebase: added to javascript namespace for uniqueness			
    • 
					
  • 
				string
				$back: label for 'previous' button			
    • 
					
  • 
				string
				$fwd: label for 'next' button			
    • 
					
  • 
				array
				$keys: list of js id tags for the text boxes to alter			
    • 
					
  • 
				array
				$values: list of dates to use in the sequence			
    • 
					
  • 
				integer
				$counter: initial position in sequence			
    • 
				

		
			
	




	
	

		displayBack (line 133)
	
 
	
	

generate the back link

	
    
				
  • return: html link to fire the previous event
    • 
			

	
	

		string
		
			displayBack
		
				()
			

	
		
			
	




	
	

		displayFwd (line 124)
	
 
	
	

generate the forward link

	
    
				
  • return: html link to fire the forwards event
    • 
			

	
	

		string
		
			displayFwd
		
				()
			

	
		
			
	




	
	

		displayJS (line 80)
	
 
	
	

generate the javascript for the +/- links

	
    
				
  • return: javascript embedded in html for necessary functions and data
    • 
			

	
	

		string
		
			displayJS
		
				()
			

	
		
			
	

						
		

	



	

		Documentation generated on Tue, 06 Mar 2007 10:01:44 +0000 by phpDocumentor 1.3.0