Class Xyster_Orm_Plugin_Broker

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

A broker for plugins

  • copyright: Copyright (c) 2007-2008 Irrational Logic (http://irrationallogic.net)
  • license: New BSD License

Located in /Orm/Plugin/Broker.php (line 24) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

																								

					array
					$_plugins
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																																																																																																				
												

											Xyster_Orm_Plugin_Abstract|array|false
										getPlugin
											(string $class)
									

																

											array
										getPlugins
										()
									

																

											boolean
										hasPlugin
											(string $class)
									

																

											void
										postDelete
											(Xyster_Orm_Entity $entity)
									

																

											void
										postInsert
											(Xyster_Orm_Entity $entity)
									

																

											void
										postLoad
											(Xyster_Orm_Entity $entity)
									

																

											void
										postUpdate
											(Xyster_Orm_Entity $entity)
									

																

											void
										preDelete
											(Xyster_Orm_Entity $entity)
									

																

											void
										preInsert
											(Xyster_Orm_Entity $entity)
									

																

											void
										preUpdate
											(Xyster_Orm_Entity $entity)
									

																

											Xyster_Orm_Plugin_Broker
										registerPlugin
											(Xyster_Orm_Plugin_Abstract $plugin, [int $stackIndex = null])
									

																

											Xyster_Orm_Plugin_Broker
										unregisterPlugin
											(string|Xyster_Orm_Plugin_Abstract $plugin)
									

								

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			array
			$_plugins
			 = array()			(line 31)
		
	


	

Array of Xyster_Orm_Plugin_Abstract objects

	
    
				
  • access: protected
    • 
			

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			




	
	

		getPlugin (line 39)
	
 
	
	

Retrieve a plugin or plugins by class

	
    
				
  • return: False if none, the plugin if only one, and array of plugins if multiple of same class
    • 
				
  • access: public
    • 
			

	
	

		Xyster_Orm_Plugin_Abstract|array|false
		
			getPlugin
		
					(string $class)
			

	
			
    
					
  • 
				string
				$class: Class name of plugin(s) desired			
    • 
				

		
			
	




	
	

		getPlugins (line 64)
	
 
	
	

Retrieve all plugins

	
    
				
  • access: public
    • 
			

	
	

		array
		
			getPlugins
		
				()
			

	
		
			
	




	
	

		hasPlugin (line 75)
	
 
	
	

Checks whether a plugin of a particular class is registered

	
    
				
  • access: public
    • 
			

	
	

		boolean
		
			hasPlugin
		
					(string $class)
			

	
			
    
					
  • 
				string
				$class			
    • 
				

		
			
	




	
	

		postDelete (line 91)
	
 
	
	

Called prior to an entity being deleted

	
    
				
  • access: public
    • 
			

	
	

		void
		
			postDelete
		
					(Xyster_Orm_Entity $entity)
			

	
			
		
			
	




	
	

		postInsert (line 104)
	
 
	
	

Called prior to an entity being inserted

	
    
				
  • access: public
    • 
			

	
	

		void
		
			postInsert
		
					(Xyster_Orm_Entity $entity)
			

	
			
		
			
	




	
	

		postLoad (line 117)
	
 
	
	

Called after a new entity is loaded with values

	
    
				
  • access: public
    • 
			

	
	

		void
		
			postLoad
		
					(Xyster_Orm_Entity $entity)
			

	
			
		
			
	




	
	

		postUpdate (line 130)
	
 
	
	

Called prior to an entity being updated

	
    
				
  • access: public
    • 
			

	
	

		void
		
			postUpdate
		
					(Xyster_Orm_Entity $entity)
			

	
			
		
			
	




	
	

		preDelete (line 143)
	
 
	
	

Called prior to an entity being deleted

	
    
				
  • access: public
    • 
			

	
	

		void
		
			preDelete
		
					(Xyster_Orm_Entity $entity)
			

	
			
		
			
	




	
	

		preInsert (line 156)
	
 
	
	

Called prior to an entity being inserted

	
    
				
  • access: public
    • 
			

	
	

		void
		
			preInsert
		
					(Xyster_Orm_Entity $entity)
			

	
			
		
			
	




	
	

		preUpdate (line 169)
	
 
	
	

Called prior to an entity being updated

	
    
				
  • access: public
    • 
			

	
	

		void
		
			preUpdate
		
					(Xyster_Orm_Entity $entity)
			

	
			
		
			
	




	
	

		registerPlugin (line 184)
	
 
	
	

Register a plugin

	
    
				
  • return: provides a fluent interface
    • 
				
  • access: public
    • 
			

	
	

		Xyster_Orm_Plugin_Broker
		
			registerPlugin
		
					(Xyster_Orm_Plugin_Abstract $plugin, [int $stackIndex = null])
			

	
			
		
			
	




	
	

		unregisterPlugin (line 218)
	
 
	
	

Unregister a plugin.

	
    
				
  • return: provides a fluent interface
    • 
				
  • access: public
    • 
			

	
	

		Xyster_Orm_Plugin_Broker
		
			unregisterPlugin
		
					(string|Xyster_Orm_Plugin_Abstract $plugin)
			

	
			
		
			
	

						
		

	



	

		Documentation generated on Mon, 19 May 2008 17:07:01 -0400 by phpDocumentor 1.4.2