Package: plugin

Class Erfurt_PluginManager







	
Description

	

		

Erfurt Plugin Manager
 Provides methods to initialize and activate plugins founded in a submitted directory, save their configurations, instanciate their classes by request and announce plugin methods to event dispatcher as subscriber/listener.

	
    
				
  • author: Michael Haschke
    • 
				
  • version: $Id: PluginManager.php 1638 2007-11-13 19:53:20Z p_frischmuth $
    • 
			

		
				
			

	

					Description |
															Methods (details)
						
					







	
	

		

			

				Method Summary
			

																																																			
									

				
											Erfurt_PluginManager
									
				
					__construct
					( $o)
									
			

												

				
											Mixed
									
				
					getPluginRoot
					(String $classname)
									
			

												

				
											Bool
									
				
					init
					(String $folder, [Bool $refresh = false]
						)
									
			

												

				
											Mixed
									
				
					prepare
					(String $classname)
									
			

												

				
											void
									
				
					__get
					( $v)
									
			

												

				
											void
									
				
					__isset
					( $v)
									
			

												

				
											void
									
				
					__set
					( $vName,  $vValue)
									
			

												

				
											void
									
				
					__unset
					( $v)
									
			

								

		

			Description |
												Methods (details)
		

	
		

	
	
	

		
Methods

		

											
			
		

			

				
									Constructor 
								__construct
				
							
 
			
			

				Erfurt_PluginManager
				
								__construct
				
									(																		
						$o
											)
							

	
				
    
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						
						$o
											
    • 
								

				
						
				
					

				
		

			

				
								getPluginRoot
				
							
 
			
			

				Mixed
				
								getPluginRoot
				
									(																		String
						$classname
											)
							

	
			
Erfurt_PluginManager::getPluginRoot() returns absolute root dir path of plugin using submitted class

	
    
				
  • return: o String: absolute path of plugin root dir
    • Bool false: class not known
    • 
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						String
						$classname
													
							: name of plugin class
							
											
    • 
								

				
						
				
					

				
		

			

				
								init
				
							
 
			
			

				Bool
				
								init
				
									(																		String
						$folder
																								, 
																			[
												Bool
						$refresh
												 	 = 
							
							false
							]
											)
							

	
			
Erfurt_PluginManager::init() init plugins to system

	
    
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						String
						$folder
													
							: absolute path to plugins
							
											
    • 
									
  • 
						Bool
						$refresh
													
							: delete all data when true (default: false)
							
											
    • 
								

				
						
				
					

				
		

			

				
								prepare
				
							
 
			
			

				Mixed
				
								prepare
				
									(																		String
						$classname
											)
							

	
			
Erfurt_PluginManager::prepare() prepare system environment for usage of class:method from a plugin

	
    
				
  • return: o class object: success
    • bool false: preparation failed
    • 
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						String
						$classname
													
							: name of plugin class
							
											
    • 
								

				
						
				
					

				
		

			

				
								__get
				
							
 
			
			

				void
				
								__get
				
									(																		
						$v
											)
							

	
				
    
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						
						$v
											
    • 
								

				
						
				
					

				
		

			

				
								__isset
				
							
 
			
			

				void
				
								__isset
				
									(																		
						$v
											)
							

	
				
    
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						
						$v
											
    • 
								

				
						
				
					

				
		

			

				
								__set
				
							
 
			
			

				void
				
								__set
				
									(																		
						$vName
																								, 
																		
						$vValue
											)
							

	
				
    
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						
						$vName
											
    • 
									
  • 
						
						$vValue
											
    • 
								

				
						
				
					

				
		

			

				
								__unset
				
							
 
			
			

				void
				
								__unset
				
									(																		
						$v
											)
							

	
				
    
				
  • access: public
    • 
			

	
							
Parameters:

				
    
									
  • 
						
						$v
											
    • 
								

				
						
				
					

							
		

		

			Description |
																Methods (details)
						
		

	





	Documentation generated on 2009-01-06 at 01:01 by 
	phpDocumentor 1.4.1