Interface WFPagedData

Description
Description | Methods (details)

An interface / formal protocol for accesing paged data.

All WFPaginator objects need a dataDelegate to fetch the paged data. Any class implementing WFPagedData will work.

Located in /framework/WFPagination.php (line 801) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																				
												

											integer
										itemCount
										()
									

																

											array
										itemsAtIndex
											(integer $startIndex, integer $numItems, array $sortKeys)
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			




	
	

		itemCount (line 808)
	
 
	
	

Get the total number of items in the paged data.

	
    
				
  • return: The total number of items.
    • 
			

	
	

		integer
		
			itemCount
		
				()
			

	
		
			
	




	
	

		itemsAtIndex (line 819)
	
 
	
	

Get a page of the managed items.

	
    
				
  • return: The subest of items in the current page.
    • 
			

	
	

		array
		
			itemsAtIndex
		
					(integer $startIndex, integer $numItems, array $sortKeys)
			

	
			
    
					
  • 
				integer
				$startIndex: The first item is index 1.			
    • 
					
  • 
				integer
				$numItems: The number of items to fetch in the page.			
    • 
					
  • 
				array
				$sortKeys: The sort info for the data. This is an array of the "sort keys" that was set via WFPaginator::setSortOptions().                It is up to the client class to correctly interpret this sort data.			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Sun, 28 Sep 2008 18:25:08 -0400 by phpDocumentor 1.4.1