Class Amfphp_Core_PluginManager

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

Loads plugins for Amfphp. Plugins consist of a folder in the plugins folder. The folder and the class should all have the same name. The file containing the class should be named with the class name with the '.php' suffix added.

It is the loaded class' responsability to load any other resources that the plugin needs from the same folder. A plugin interacts with Amfphp by using the Amfphp_Core_FilterManager to register its functions to be called at specific times with specific parameters during execution. It's a singleton, so use getInstance

  • author: Ariel Sommeria-Klein

Located in /Amfphp/Core/PluginManager.php (line 24) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

												

					static Amfphp_Core_PluginManager
					$instance
				

																																				

					array
					$pluginInstances
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																				

					static 						Amfphp_Core_PluginManager
										getInstance
										()
									

																
												

											Amfphp_Core_PluginManager
										__construct
										()
									

																								

											void
										loadPlugins
											(array $pluginFolders, [ $pluginsConfig = null], [ $sharedConfig = null], [ $disabledPlugins = null], array $sharedConfig.)
									

								

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			static Amfphp_Core_PluginManager
			$instance
			 =  NULL			(line 31)
		
	


	

protected instance of singleton

	
    
				
  • access: protected
    • 
			

	
	
		
		







	

		
			array
			$pluginInstances
						(line 37)
		
	


	
	
    
				
  • access: protected
    • 
			

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			



	
	

		static method getInstance (line 50)
	
 
	
	

gives access to the singleton

	
    
				
  • access: public
    • 
			

	
	

	    static
		Amfphp_Core_PluginManager
		
			getInstance
		
				()
			

	
		
			
	





	
	

		Constructor __construct (line 42)
	
 
	
	

constructor

	
    
				
  • access: protected
    • 
			

	
	

		Amfphp_Core_PluginManager
		
			__construct
		
				()
			

	
		
			
	




	
	

		loadPlugins (line 65)
	
 
	
	

load the plugins

	
    
				
  • access: public
    • 
			

	
	

		void
		
			loadPlugins
		
					(array $pluginFolders, [ $pluginsConfig = null], [ $sharedConfig = null], [ $disabledPlugins = null], array $sharedConfig.)
			

	
			
    
					
  • 
				array
				$pluginFolders: where to load the plugins from. Absolute paths. For example Amfphp/Plugins/			
    • 
					
  • 
				array
				$pluginsConfig: . optional. an array containing the plugin configuration, using the plugin name as key.			
    • 
					
  • 
				array
				$sharedConfig.: optional. if both a specific config and a shared config are available, concatenate them to create the plugin config.  Otherwise use whatever is not null			
    • 
					
  • 
				array
				$disabledPlugins: . optional.  an array of names of plugins to disable			
    • 
					
  • 
				array
				$sharedConfig			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Mon, 23 Jan 2012 17:22:06 -0300 by phpDocumentor 1.4.3