VirtueMart

Plugin system » History » Revision 7

Revision 6 (Oscar van Eijk, 02/07/2011 02:09 PM) → Revision 7/42 (Oscar van Eijk, 02/07/2011 02:22 PM)

h1. Plugin system 

 Since VirtueMart v2, the Joomla! plugin system is used form payment and shipper plugins. 

 h2. Installing plugins 

 During development the the VM2 branch, the plugins are not available as Joomla install packages, so for test environments, they must be installed manually. 

 h3. Payment plugins 

 At the time of writing, only 2 of the former payment plugins have been converted to the new plugin system. Others should follow soon, all help is appreciated!! 

 Use the SQL query below to add the plugins to your database (assuming the table prefix is "jos_"): 

 <pre> 
 INSERT INTO `jos_plugins` (`id`, `name`, `element`, `folder`, `access`, `ordering` 
   , `published`, `iscore`, `client_id`, `checked_out`, `checked_out_time`, `params`) 
 VALUES 
  (NULL, 'VMPayment - Authorize', 'authorize', 'vmpayment', 0, 0, 1, 0, 0, 0, '0000-00-00 00:00:00', '') 
 ,(NULL, 'VMPayment - Cash on delivery', 'cashondel', 'vmpayment', 0, 0, 1, 0, 0, 0, '0000-00-00 00:00:00','') 
 ; 
 </pre> 

 Next, copy the plugin files (authorize.php, authorize.xml, cashondel.php and cashondel.xml), located in the folder /plugins/vmpayment in the SVN checkout, to the Joomla plugin directory. If that doesn't exist, it must be created first: <pre>mkdir <document_root>/plugins/vmpayment</pre> 

 Now, in the store maintenance, you can add payment methods based on one of these plugins. Note at this moment it is required to select a vendor! 

 h3. Shipper plugins 

 This is very similar to the payment plugins. Only 1 plugin has been created (again: all help is appreciated!); 'standard', which provides a basic shipping option for postal services. 
 *Note:* Installing the sample data does _NOT_ provide shipping rates anymore! 

 Use the SQL query below to add the plugins to your database (assuming the table prefix is "jos_"): 

 <pre> 
 INSERT INTO `jos_plugins` (`id`, `name`, `element`, `folder`, `access`, `ordering` 
   , `published`, `iscore`, `client_id`, `checked_out`, `checked_out_time`, `params`) 
 VALUES 
  (NULL, 'VMShipper - Standard', 'standard', 'vmshipper', 0, 0, 1, 0, 0, 0, '0000-00-00 00:00:00', '') 
 ; 
 </pre> 

 Next, copy the plugin files (standard.php and standard.xml), located in the folder /plugins/vmshipper in the SVN checkout, to the Joomla plugin directory. If that doesn't exist, it must be created first: <pre>mkdir <document_root>/plugins/vmshipper</pre> 

 Now use the 'Shipping' menu item in the backend to add 1 or more carriers based on this plugin. All you need to do here is give the shipper a name and select a vendor (this is optional; when no vendor is selected, this carrier is valid for all vendors). 
 Finally you can add the shipping rates for the created vendor. Make sure a there's always a valid shipping rate: customers select the carrier only and the plugin must be able to find a mathcing rate based on the total order weight and the shipto address! 

 h2. Plugin Development 

 All plugins for VirtueMart should be developed confirming the Joomla! plugin development methods. Refer to http://docs.joomla.org/Tutorial:Plugins for developers documentation for Joomla! plugins. 

 h3. Payment Plugins 

 Payment plugins are used both in the front-end and the backend. They must be created as classes deriving from the base class *vmPaymentPlugin*: 
 <pre> 
 class plgVmPayment<myPlugin> extends vmPaymentPlugin { 
	 function plgVmPayment<myPlugin>(&$subject, $config) { 
		 $this->_pelement = basename(__FILE__, '.php'); 	 // Required! 
		 $this->_createTable(); 				 // Required, see below 
		 parent::__construct($subject, $config); 
	 } 
 } 
 </pre> 

 Below is the list with events and a description on what moment they are fired. 
 * *plgVmOnSelectPayment()* - This event is fired during the checkout process. It allows the shopper to select one of the available payment methods. 
 It should display a radio button (name: paym_id) to select the payment method. Other information (like credit card info) might be selected as well, depending on the plugin. 
 +Return:+ 
 It must return the HTML code for displaying the form (radio button and optional extra selections). 
 +Parameters:+ 
 # (VirtueMartCart object) The cart object  
 # (integer, default 0) ID of an already selected payment method ID, if any 

 * *plgVmOnPaymentSelectCheck()* - This event is fired after the payment method has been selected. It can be used to store 
 additional payment info in the cart. 
 +Return:+ 
 Plugins that were not selected must return null, otherwise True of False must be returned indicating Success or Failure. 
 +Parameters:+ 
 # (VirtueMartCart object) The cart object  

 * *plgVmOnCheckoutCheckPaymentData()* - This event is fired during the checkout process. It can be used to validate the payment data as entered by the user. 
 +Return:+ 
 Plugins that were not selected must return null, otherwise True of False must be returned indicating Success or Failure. 
 +Parameters:+ 
 None 

 * *plgVmOnConfirmedOrderStorePaymentData()* - This event is fired after the payment has been processed; it stores the payment method-specific data. 
 All plugins _must_ reimplement this method. 
 +Return:+ 
 If the plugin is NOT actually executed (not the selected payment method), this method must return NULL 
 If this plugin IS executed, it MUST return the order status code that the order should get. This triggers the stock updates if required 
 +Parameters:+ 
 # (integer) The ordernumber being processed 
 # (object) Data from the cart 
 # (array) Price information for this order 
	
 * *plgVmOnShowOrderPaymentBE()* - This method is fired when showing the order details in the backend. It displays the the payment method-specific data. 
 All plugins _must_ reimplement this method. 
 +Return:+ 
 Null when for payment methods that were not selected, text (HTML) otherwise 
 +Parameters:+ 
 # (integer) The order ID 
 # (integer) Payment method used for this order 

 * *plgVmOnCancelPayment()* - This event is fired each time the status of an order is changed to Cancelled. It can be used to refund payments, void authorization etc. 
 When reimplementing this methis, the body _must_ start with this code: 
 <pre>$_paymethodID = $this->getPaymentMethodForOrder($_orderID); 
 if (!$this->selectedThisMethod($this->_pelement, $_paymethodID)) { 
	 return; 
 }</pre> 
 +Parameters:+ 
  (integer The order ID 
  (char) Previous order status 
  (char) New order status 

 * *plgVmOnShipOrderPayment()* - This event is fired when the status of an order is changed to Shipped. It can be used to confirm or capture payments 
 When reimplementing this methis, the body _must_ start with this code: 
 <pre>$_paymethodID = $this->getPaymentMethodForOrder($_orderID); 
 if (!$this->selectedThisMethod($this->_pelement, $_paymethodID)) { 
	 return; 
 }</pre> 
 +Return:+ 
 True on success, False on failure, Null if this plugin was not activated 
 +Parameters:+ 
 # (integer) Order ID 

 Other helper functions inherited from the base class: 

 * _createTable() - This method is used to create and maintain the plugin specific database table(s). 
 It _must_ be reimplemented by all plugins. 
 +Example:+ 
 $_scheme = DbScheme::get_instance(); 
 $_scheme->create_scheme('#__vm_order_payment_'.$this->_pelement); 
 $_schemeCols = array( 
	  'id' => array ( 
			  'type' => 'int' 
			 ,'length' => 11 
			 ,'auto_inc' => true 
			 ,'null' => false 
	 ) 
	 ,'order_id' => array ( 
			  'type' => 'int' 
			 ,'length' => 11 
			 ,'null' => false 
	 ) 
	 ,'payment_method_id' => array ( 
			  'type' => 'text' 
			 ,'null' => false 
	 ) 
 ); 
 $_schemeIdx = array( 
	  'idx_order_payment' => array( 
			  'columns' => array ('order_id') 
			 ,'primary' => false 
			 ,'unique' => false 
			 ,'type' => null 
	 ) 
 ); 
 $_scheme->define_scheme($_schemeCols); 
 $_scheme->define_index($_schemeIdx); 
 if (!$_scheme->scheme()) { 
	 JError::raiseWarning(500, $_scheme->get_db_error()); 
 } 
 $_scheme->reset(); 
 <pre> 
 </pre> 

 *getPaymentMethodForOrder() - Get the order payment ID for a given order number 
 +Return:+ 
 The payment method ID, or -1 when not found  
 +Parameters:+ 
 # (integer) The order ID 

 * getThisMethodName() - Get the name of the payment method. 
 This method can _not_ be reimplemented 
 +Return:+ 
 Paymenent method name 
 +Parameters:+ 
 # (integer) The payment method ID 

 * selectedThisMethod() - This method checks if the selected payment method matches the current plugin 
 +Return:+ 
 True if the calling plugin has the given payment ID, False otherwise. 
 +Parameters:+ 
 # (string) Element name, taken from the plugin filename 
 # (integer) The payment method ID 

 * writePaymentData() - This method writes all payment plugin specific data to the plugin's table 
 +Return:+ 
 True if the calling plugin has the given payment ID, False otherwise. 
 +Parameters:+ 
 # (array) Indexed array in the format 'column_name' => 'value' 
 # (string) Table name