Code:
<?php
/*
THIS IS EXAMPLE CODE ONLY!!!
I have never programmed in PHP and this is 'best guess only' hack.
$Id: EMOcorp.php,v 0.1beta 2004/03/25 19:57:15 hpdl Exp $
osCommerce, Open Source E-Commerce Solutions
http://www.oscommerce.com
Released under the GNU General Public License
Goal is to take the following web form and convert it into a web payment modual for oscommerce.
<form action="https://www.emocorp.com/s/action/PaymentAction" method="post">
<input type="hidden" name="merchant_email" value="sales@MyWebAddress.com">
<input type="hidden" name="merchant_name" value="My Business Name">
<input type="hidden" name="amount" value="34.39">
<input type="hidden" name="reference" value="2 face decals Plus S & H">
<input type="hidden" name="return_url" value="http://www.MyWebAddress.com">
<input name="" type="image" src="https://www.emocorp.com/resources/ui/skins/default/images/pay_emo.gif">
</form>
We are modifying the paypal payment modual for our interface.
Here are some variables being used below.
MODULE_PAYMENT_PAYPAL_STATUS switch used to turn modual on and off.
MODULE_PAYMENT_PAYPAL_ID email address used by paypal
MODULE_PAYMENT_PAYPAL_CURRENCY currency you are paid in
MODULE_PAYMENT_PAYPAL_ZONE Shipping zone variable
MODULE_PAYMENT_PAYPAL_ORDER_STATUS_ID Sounds like a pending ID variable or final
MODULE_PAYMENT_PAYPAL_SORT_ORDER Determins where in list this payment option sets.
The above variables are set into the database by the install function below.
I would suggest modifying the word PAYPAL in the above variable to some other Payment processors name.
For my purpose EMOCORP should work.
*/
// References to paypal need to be changed
// I could be wrong on the terminology but this seems to be setting up some structured variable.
// Reminds me of C language.
//Probably change 'paypal' to 'emocorp'
class paypal {
var $code, $title, $description, $enabled;
// class constructor
// This seems to be defining the variables in the structure.
//Probably change 'paypal' to 'emocorp'
// again change PAYPAL to EMOCORP
function paypal() {
global $order;
$this->code = 'paypal';
$this->title = MODULE_PAYMENT_PAYPAL_TEXT_TITLE;
$this->description = MODULE_PAYMENT_PAYPAL_TEXT_DESCRIPTION;
$this->sort_order = MODULE_PAYMENT_PAYPAL_SORT_ORDER;
$this->enabled = ((MODULE_PAYMENT_PAYPAL_STATUS == 'True') ? true : false);
if ((int)MODULE_PAYMENT_PAYPAL_ORDER_STATUS_ID > 0) {
$this->order_status = MODULE_PAYMENT_PAYPAL_ORDER_STATUS_ID;
}
if (is_object($order)) $this->update_status();
// This is the link that will need to be changed to...
// 'https://www.emocorp.com/s/action/PaymentAction' to process transaction.
$this->form_action_url = 'https://secure.paypal.com/cgi-bin/webscr';
}
// class methods
function update_status() {
global $order;
// again change PAYPAL to EMOCORP
if ( ($this->enabled == true) && ((int)MODULE_PAYMENT_PAYPAL_ZONE > 0) ) {
$check_flag = false;
$check_query = tep_db_query("select zone_id from " . TABLE_ZONES_TO_GEO_ZONES . " where geo_zone_id = '" . MODULE_PAYMENT_PAYPAL_ZONE . "' and zone_country_id = '" . $order->billing['country']['id'] . "' order by zone_id");
while ($check = tep_db_fetch_array($check_query)) {
if ($check['zone_id'] < 1) {
$check_flag = true;
break;
} elseif ($check['zone_id'] == $order->billing['zone_id']) {
$check_flag = true;
break;
}
}
if ($check_flag == false) {
$this->enabled = false;
}
}
}
function javascript_validation() {
return false;
}
function selection() {
return array('id' => $this->code,
'module' => $this->title);
}
function pre_confirmation_check() {
return false;
}
function confirmation() {
return false;
}
// This is where the magic happens. When customer clicks to submit payment, the will be redirected to payment companies web site.
function process_button() {
global $order, $currencies, $currency;
// this appears to be for compatibility of multiple currencies.
if (MODULE_PAYMENT_PAYPAL_CURRENCY == 'Selected Currency') {
$my_currency = $currency;
} else {
$my_currency = substr(MODULE_PAYMENT_PAYPAL_CURRENCY, 5);
}
if (!in_array($my_currency, array('CAD', 'EUR', 'GBP', 'JPY', 'USD'))) {
$my_currency = 'USD';
}
// these are the strings and variables to be passed to the payment website
$process_button_string = tep_draw_hidden_field('cmd', '_xclick') .
tep_draw_hidden_field('business', MODULE_PAYMENT_PAYPAL_ID) .
tep_draw_hidden_field('item_name', STORE_NAME) .
tep_draw_hidden_field('amount', number_format(($order->info['total'] - $order->info['shipping_cost']) * $currencies->get_value($my_currency), $currencies->get_decimal_places($my_currency))) .
tep_draw_hidden_field('shipping', number_format($order->info['shipping_cost'] * $currencies->get_value($my_currency), $currencies->get_decimal_places($my_currency))) .
tep_draw_hidden_field('currency_code', $my_currency) .
tep_draw_hidden_field('return', tep_href_link(FILENAME_CHECKOUT_PROCESS, '', 'SSL')) .
tep_draw_hidden_field('cancel_return', tep_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL'));
return $process_button_string;
}
/*
sample paypal html web form for comparison purpose
<form name="_xclick" action="https://www.paypal.com/cgi-bin/webscr" method="post">
<input type="hidden" name="cmd" value="_xclick">
<input type="hidden" name="business" value="me@mybusiness.com">
<input type="hidden" name="currency_code" value="USD">
<input type="hidden" name="item_name" value="Teddy Bear">
<input type="hidden" name="amount" value="12.99">
<input type="image" src="http://www.paypal.com/en_US/i/btn/x-click-but01.gif" border="0" name="submit" alt="Make payments with PayPal - it's fast, free and secure!">
</form>
Looking above we can see that 'input type="hidden" ' lines are converted into tep_draw_hidden_field commands().
The question is how does the script know where to send the tep_draw_hidden_field commands()to.
The answer should be "https://www.paypal.com/cgi-bin/webscr".
This can be found up at the top defined in the line '$this->form_action_url'
*/
// Theory is that this is used to process the payment before sending payment??
function before_process() {
return false;
}
// Theory is that this is used to handle payment clean up details such as notifying shopping cart payment is confirmed(If possible).
function after_process() {
return false;
}
// Probably to detect failed pament transaction of some sort.
function output_error() {
return false;
}
function check() {
if (!isset($this->_check)) {
$check_query = tep_db_query("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_PAYMENT_PAYPAL_STATUS'");
$this->_check = tep_db_num_rows($check_query);
}
return $this->_check;
}
// This is obviously setup configuration in the administration
function install() {
// again change PAYPAL to EMOCORP
tep_db_query("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Enable PayPal Module', 'MODULE_PAYMENT_PAYPAL_STATUS', 'True', 'Do you want to accept PayPal payments?', '6', '3', 'tep_cfg_select_option(array(\'True\', \'False\'), ', now())");
tep_db_query("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('E-Mail Address', 'MODULE_PAYMENT_PAYPAL_ID', 'you@yourbusiness.com', 'The e-mail address to use for the PayPal service', '6', '4', now())");
tep_db_query("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Transaction Currency', 'MODULE_PAYMENT_PAYPAL_CURRENCY', 'Selected Currency', 'The currency to use for credit card transactions', '6', '6', 'tep_cfg_select_option(array(\'Selected Currency\',\'Only USD\',\'Only CAD\',\'Only EUR\',\'Only GBP\',\'Only JPY\'), ', now())");
tep_db_query("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Sort order of display.', 'MODULE_PAYMENT_PAYPAL_SORT_ORDER', '0', 'Sort order of display. Lowest is displayed first.', '6', '0', now())");
tep_db_query("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, use_function, set_function, date_added) values ('Payment Zone', 'MODULE_PAYMENT_PAYPAL_ZONE', '0', 'If a zone is selected, only enable this payment method for that zone.', '6', '2', 'tep_get_zone_class_title', 'tep_cfg_pull_down_zone_classes(', now())");
tep_db_query("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, use_function, date_added) values ('Set Order Status', 'MODULE_PAYMENT_PAYPAL_ORDER_STATUS_ID', '0', 'Set the status of orders made with this payment module to this value', '6', '0', 'tep_cfg_pull_down_order_statuses(', 'tep_get_order_status_name', now())");
}
// Obviously to remove this payment option once installed.
function remove() {
tep_db_query("delete from " . TABLE_CONFIGURATION . " where configuration_key in ('" . implode("', '", $this->keys()) . "')");
}
// Unknown??
function keys() {
// again change PAYPAL to EMOCORP
return array('MODULE_PAYMENT_PAYPAL_STATUS', 'MODULE_PAYMENT_PAYPAL_ID', 'MODULE_PAYMENT_PAYPAL_CURRENCY', 'MODULE_PAYMENT_PAYPAL_ZONE', 'MODULE_PAYMENT_PAYPAL_ORDER_STATUS_ID', 'MODULE_PAYMENT_PAYPAL_SORT_ORDER');
}
}
?> 
LinkBack URL
About LinkBacks
Payment (and other module) Documentation 
I welcome any documentation that you can add to the project. 
Bookmarks