Class Hook_work

Description
Description | Methods (details)

Located in /sources/hooks/systems/ecommerce/work.php (line 21) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																												
												

											?tempcode
										get_identifier_manual_field_inputter
											(ID_TEXT $type_code)
									

																

											array
										get_products
										()
									

																

											?MEMBER
										member_for
											(ID_TEXT $purchase_id)
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			




	
	

		get_identifier_manual_field_inputter (line 30)
	
 
	
	

Function for administrators to pick an identifier (only used by admins, usually the identifier would be picked via some other means in the wider ocPortal codebase).

	
    
				
  • return: Input field in standard Tempcode format for fields (NULL: no identifier).
    • 
			

	
	

		?tempcode
		
			get_identifier_manual_field_inputter
		
					(ID_TEXT $type_code)
			

	
			
    
					
  • 
				ID_TEXT
				$type_code: Product type code.			
    • 
				

		
			
	




	
	

		get_products (line 62)
	
 
	
	

Get the products handled by this eCommerce hook.


IMPORTANT NOTE TO PROGRAMMERS: This function may depend only on the database, and not on get_member() or any GET/POST values.   Such dependencies will break IPN, which works via a Guest and no dependable environment variables. It would also break manual transactions from the Admin Zone.

	
    
				
  • return: A map of product name to list of product details.
    • 
			

	
	

		array
		
			get_products
		
				()
			

	
		
			
	




	
	

		member_for (line 49)
	
 
	
	

Find the corresponding member to a given purchase ID.

	
    
				
  • return: The member (NULL: unknown / can't perform operation).
    • 
			

	
	

		?MEMBER
		
			member_for
		
					(ID_TEXT $purchase_id)
			

	
			
    
					
  • 
				ID_TEXT
				$purchase_id: The purchase ID.			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Sun, 02 Jan 2011 23:29:16 +0000 by phpDocumentor 1.4.3