Class pager

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

class for doing paging

Located in /lib/pager.php (line 24) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

																																																																

					int
					$from
				

																

					int
					$numPages
				

																

					array
					$pagerData
				

																

					int
					$total
				

																

					string
					$url
				

																

					string
					$urlEnd
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																																														
				

											pager
										__construct
											(int $total)
									

														
				

											string
										getPagerHTML
										()
									

														
				

											void
										setUrlEnd
											(string $str)
									

														
				

											void
										validate
										()
									

											

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			int
			$from
			 =  0			(line 38)
		
	


	
	
    
				
  • var: where from do we start paging
    • 
				
  • access: public
    • 
			

	
	
		
		







	

		
			int
			$numPages
						(line 47)
		
	


	
	
    
				
  • var: sum of all pages
    • 
				
  • access: public
    • 
			

	
	
		
		







	

		
			array
			$pagerData
			 = array()			(line 64)
		
	


	
	
    
				
  • var: array with pager data, to be used when generating html
    • 
				
  • access: public
    • 
			

	
	
		
		







	

		
			int
			$total
						(line 30)
		
	


	
	
    
				
  • var: total number of links to be paged.
    • 
				
  • access: public
    • 
			

	
	
		
		







	

		
			string
			$url
						(line 55)
		
	


	
	
    
				
  • var: base url to be used when showing pager.
    • 
				
  • access: public
    • 
			

	
	
		
		







	

		
			string
			$urlEnd
			 =  null			(line 73)
		
	


	
	
    
				
  • var: additions to url e.g. a search term.
    • 
				
  • access: public
    • 
			

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			



	
	

		Constructor __construct (line 81)
	
 
	
	
	
    
				
  • access: public
    • 
			

	
	

		pager
		
			__construct
		
					(int $total)
			

	
			
    
					
  • 
				int
				$total: sum of all links to be paged.			
    • 
				

		
			
	




	
	

		getPagerHTML (line 156)
	
 
	
	

method for getting pager data as html

	
    
				
  • return: containing pager html.
    • 
				
  • access: public
    • 
			

	
	

		string
		
			getPagerHTML
		
				()
			

	
		
			
	




	
	

		setUrlEnd (line 119)
	
 
	
	
	
    
				
  • access: public
    • 
			

	
	

		void
		
			setUrlEnd
		
					(string $str)
			

	
			
    
					
  • 
				string
				$str: addition to url string e.g. foo=bar			
    • 
				

		
			
	




	
	

		validate (line 97)
	
 
	
	

validation of pager data, only zero or positive int is allowed

	
    
				
  • access: public
    • 
			

	
	

		void
		
			validate
		
				()
			

	
		
			
	

						
		

	



	

		Documentation generated on Fri, 17 Dec 2010 17:56:36 +0100 by phpDocumentor 1.4.3