Class Module_admin_messaging

Description
Description | Methods (details)

Module page class.

Located in /adminzone/pages/modules/admin_messaging.php (line 24) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																																				
												

											tempcode
										choose_message
										()
									

																

											?array
										get_entry_points
										()
									

																

											?array
										info
										()
									

																

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

																

											tempcode
										run
										()
									

																

											tempcode
										take_responsibility
										()
									

																

											void
										uninstall
										()
									

																

											tempcode
										view_message
										()
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			






	
	

		choose_message (line 115)
	
 
	
	

Choose a message.

	
    
				
  • return: The message choose screen.
    • 
			

	
	

		tempcode
		
			choose_message
		
				()
			

	
		
			
	




	
	

		get_entry_points (line 82)
	
 
	
	

Standard modular entry-point finder function.

	
    
				
  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
    • 
			

	
	

		?array
		
			get_entry_points
		
				()
			

	
		
			
	




	
	

		info (line 32)
	
 
	
	

Standard modular info function.

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

	
	

		?array
		
			info
		
				()
			

	
		
			
	




	
	

		install (line 58)
	
 
	
	

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 92)
	
 
	
	

Standard modular run function.

	
    
				
  • return: The result of execution.
    • 
			

	
	

		tempcode
		
			run
		
				()
			

	
		
			
	




	
	

		take_responsibility (line 226)
	
 
	
	

Take responsibility for handling a message.

	
    
				
  • return: Success message.
    • 
			

	
	

		tempcode
		
			take_responsibility
		
				()
			

	
		
			
	




	
	

		uninstall (line 47)
	
 
	
	

Standard modular uninstall function.

	
	

		void
		
			uninstall
		
				()
			

	
		
			
	




	
	

		view_message (line 157)
	
 
	
	

View a message.

	
    
				
  • return: The message view screen.
    • 
			

	
	

		tempcode
		
			view_message
		
				()
			

	
		
			
	

						
		

	





	

		Documentation generated on Sun, 02 Jan 2011 23:07:22 +0000 by phpDocumentor 1.4.3