Class Block_main_leader_board

Description
Description | Methods (details)

Located in /sources/blocks/main_leader_board.php (line 21) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																				
												

											?array
										cacheing_environment
										()
									

																

											array
										calculate_leaderboard
											(integer $limit, BINARY $staff)
									

																

											?array
										info
										()
									

																

											void
										install
											([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
									

																

											tempcode
										run
											(array $map)
									

																

											void
										uninstall
										()
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			




	
	

		cacheing_environment (line 48)
	
 
	
	

Standard modular cache function.

	
    
				
  • return: Map of cache details (cache_on and ttl) (NULL: module is disabled).
    • 
			

	
	

		?array
		
			cacheing_environment
		
				()
			

	
		
			
	




	
	

		calculate_leaderboard (line 148)
	
 
	
	

Calculate the leaderboard.

	
    
				
  • return: A map of member-ids to points, sorted by leaderboard status, of the top posters (doing for points would be too inefficient)
    • 
			

	
	

		array
		
			calculate_leaderboard
		
					(integer $limit, BINARY $staff)
			

	
			
    
					
  • 
				integer
				$limit: The number to show on the leaderboard			
    • 
					
  • 
				BINARY
				$staff: Whether to include staff			
    • 
				

		
			
	




	
	

		info (line 29)
	
 
	
	

Standard modular info function.

	
    
				
  • return: Map of module info (NULL: module is disabled).
    • 
			

	
	

		?array
		
			info
		
				()
			

	
		
			
	




	
	

		install (line 62)
	
 
	
	

Standard modular install function.

	
	

		void
		
			install
		
					([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
			

	
			
    
					
  • 
				?integer
				$upgrade_from: What version we're upgrading from (NULL: new install)			
    • 
					
  • 
				?integer
				$upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)			
    • 
				

		
			
	




	
	

		run (line 94)
	
 
	
	

Standard modular run function.

	
    
				
  • return: The result of execution.
    • 
			

	
	

		tempcode
		
			run
		
					(array $map)
			

	
			
    
					
  • 
				array
				$map: A map of parameters.			
    • 
				

		
			
	




	
	

		uninstall (line 82)
	
 
	
	

Standard modular uninstall function.

	
	

		void
		
			uninstall
		
				()
			

	
		
			
	

						
		

	



	

		Documentation generated on Sun, 02 Jan 2011 23:17:30 +0000 by phpDocumentor 1.4.3