Class PageLister_HtmlHandler

Description
Description | Methods (details)

HTML handler for output

HTML handler for output

Located in /PageLister_HtmlHandler.class.php (line 32) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											string
										GenerateHTML
											(int $pages, int $currentPage, string $url)
									

								
				

											boolean
										SetFormat
											(string $format)
									

								
				

											boolean
										SetObject
											(string $object, string $value)
									

								
				

											void
										SetPagesBeside
											(int $int)
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		GenerateHTML (line 132)
	
 
	
	

Generates the HTML-code.


Generates the HTML-code.

	
    
				
  • access: public
    • 
			

	
	

		string
		
			GenerateHTML
		
					(int $pages, int $currentPage, string $url)
			

	
			
    
					
  • 
				int
				$pages			
    • 
					
  • 
				int
				$currentPage			
    • 
					
  • 
				string
				$url			
    • 
				

		
		
	




	
	

		SetFormat (line 79)
	
 
	
	

Sets the format of the HTML-output.


Sets the format of the HTML-output.
 You may want to modifie the HTML-output, so have have to change the format. You can use any HTML-code, and use the following placeholders in it:
 %FIRST% - Jump to the first page %PREV%  - Jump to the previews page %NEXT%  - Jump to the next page %LAST$  - Jump to the last page %PAGES% - The pages list

	
    
				
  • access: public
    • 
			

	
	

		boolean
		
			SetFormat
		
					(string $format)
			

	
			
    
					
  • 
				string
				$format			
    • 
				

		
		
	




	
	

		SetObject (line 100)
	
 
	
	

Sets the value of an object.


Sets the value of an object.
 Here you may change the single objects. The objects `first`, `prev`, `next` and `last` can have the placeholder %URL% in it. This is the HTML-escaped url for links. The object `placeholder` holds the placeholder before and after the pages list and the `spacer` holds the space between the pages. The object `passive_page` contains the style of a single passive page with the placeholders %URL% and %PAGE%. The `current_page` object contains the current page with the placeholders %URL% and %PAGE%.

	
    
				
  • access: public
    • 
			

	
	

		boolean
		
			SetObject
		
					(string $object, string $value)
			

	
			
    
					
  • 
				string
				$object			
    • 
					
  • 
				string
				$value			
    • 
				

		
		
	




	
	

		SetPagesBeside (line 120)
	
 
	
	

Sets how many pages should be sown beside the current one.


Sets how many pages should be sown beside the current one.
 If you set a value of 4 for example, there will be shown 4 pages before and 4 pages after the current one. If we are at the last page for example, 8 pages will be shown before the current one.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			SetPagesBeside
		
					(int $int)
			

	
			
    
					
  • 
				int
				$int			
    • 
				

		
		
	

						
		

	



	

		Documentation generated on Thu, 12 Oct 2006 12:20:38 +0200 by phpDocumentor 1.3.0RC3