Inheritance diagram for plgVmPaymentStandard:

Collaboration diagram for plgVmPaymentStandard:

Public Member Functions
	__construct (&$subject, $config)

	getVmPluginCreateTableSQL ()

	getTableSQLFields ()

	plgVmConfirmedOrder ($cart, $order)

	getNewStatus ($method)

	plgVmOnShowOrderBEPayment ($virtuemart_order_id, $virtuemart_payment_id)

	plgVmOnStoreInstallPaymentPluginTable ($jplugin_id)

	plgVmOnSelectCheckPayment (VirtueMartCart $cart, &$msg)

	plgVmDisplayListFEPayment (VirtueMartCart $cart, $selected=0, &$htmlIn)

	plgVmonSelectedCalculatePricePayment (VirtueMartCart $cart, array &$cart_prices, &$cart_prices_name)

	plgVmgetPaymentCurrency ($virtuemart_paymentmethod_id, &$paymentCurrencyId)

	plgVmOnCheckAutomaticSelectedPayment (VirtueMartCart $cart, array $cart_prices=array(), &$paymentCounter)

	plgVmOnShowOrderFEPayment ($virtuemart_order_id, $virtuemart_paymentmethod_id, &$payment_name)

	plgVmOnUserInvoice ($orderDetails, &$data)

	plgVmgetEmailCurrency ($virtuemart_paymentmethod_id, $virtuemart_order_id, &$emailCurrencyId)

	plgVmonShowOrderPrintPayment ($order_number, $method_id)

	plgVmDeclarePluginParamsPaymentVM3 (&$data)

	plgVmSetOnTablePluginParamsPayment ($name, $id, &$table)

Public Member Functions inherited from vmPSPlugin
	__construct (&$subject, $config)

	getVarsToPush ()

	setConvertable ($toConvert)

	selectedThisType ($psType)

	onStoreInstallPluginTable ($jplugin_id, $name=FALSE)

	onSelectCheck (VirtueMartCart $cart)

	displayListFE (VirtueMartCart $cart, $selected=0, &$htmlIn)

	onSelectedCalculatePrice (VirtueMartCart $cart, array &$cart_prices, &$cart_prices_name)

	onCheckAutomaticSelected (VirtueMartCart $cart, array $cart_prices=array(), &$methodCounter=0)

	selectedThisElement ($element)

	onShowOrderBE ($_virtuemart_order_id, $_method_id)

	onShowOrderPrint ($order_number, $method_id)

	onUpdateOrder ($formData)

	onUpdateOrderLine ($formData)

	onEditOrderLineBE ($orderId, $lineId)

	onShowOrderLineFE ($orderId, $lineId)

	onNotification ()

	onResponseReceived (&$virtuemart_order_id, &$html)

	getDebug ()

	setDebug ($params)

	decryptFields ($method)

	getHtmlRowBE ($key, $value)

	getSelectable (VirtueMartCart $cart, &$method_id, $cart_prices)

	convert_condition_amount (&$method)

	getEmailCurrency (&$method)

	displayTaxRule ($tax_id)

	getCosts (VirtueMartCart $cart, $method, $cart_prices)

	getCartAmount ($cart_prices)

	convertToVendorCurrency (&$method)

	setCartPrices (VirtueMartCart $cart, &$cart_prices, $method, $progressive=true)

	setInConfirmOrder ($cart)

	processConfirmedOrderPaymentResponse ($returnValue, $cart, $order, $html, $payment_name, $new_status= '')

	emptyCart ($session_id=NULL, $order_number=NULL)

	emptyCartFromStorageSession ($session_id, $order_number)

	_emptyCartFromStorageSession ($data)

	handlePaymentUserCancel ($virtuemart_order_id)

	getLogFileName ()

	debugLog ($message, $title='', $type= 'message', $doDebug=true)

Public Member Functions inherited from vmPlugin
	__construct (&$subject, $config)

	setConvertDecimal ($toConvert)

	convertDec (&$data)

	loadJLangThis ($fname, $type=0, $name=0)

	setPluginLoggable ($set=TRUE)

	setCryptedFields ($fieldNames)

	getOwnUrl ()

	display3rdInfo ($intro, $developer, $contactlink, $manlink)

	selectedThisByMethodId ($id= 'type')

	onStoreInstallPluginTable ($psType, $name=FALSE)

	getTableSQLLoggablefields ()

	getTableSQLFields ()

	setConfigParameterable ($paramsFieldName, $varsToPushParam)

	renderByLayout ($layout= 'default', $viewData=NULL, $name=NULL, $psType=NULL)

	getTemplatePath ($pluginName, $group, $layout= 'default')

Static Public Member Functions
static	getPaymentCurrency (&$method, $selectedUserCurrency=false)

Static Public Member Functions inherited from vmPSPlugin
static	getPaymentCurrency (&$method, $getCurrency=FALSE)

static	getAmountInCurrency ($amount, $currencyId)

static	getAmountValueInCurrency ($amount, $currencyId)

Static Public Member Functions inherited from vmPlugin
static	loadJLang ($fname, $type, $name)

static	getVarsToPushFromForm ($form)

static	getVarsToPushByXML ($xmlFile, $name)

Protected Member Functions
	checkConditions ($cart, $method, $cart_prices)

Protected Member Functions inherited from vmPSPlugin
	onShowOrderFE ($virtuemart_order_id, $virtuemart_method_id, &$method_info)

	getPluginMethod ($method_id)

	getPluginMethods ($vendorId)

	getDataByOrderId ($virtuemart_order_id)

	getDatasByOrderId ($virtuemart_order_id)

	getDataByOrderNumber ($order_number)

	getDatasByOrderNumber ($order_number)

	getOrderWeight (VirtueMartCart $cart, $to_weight_unit)

	getThisName ($virtuemart_method_id)

	storePSPluginInternalData ($values, $primaryKey=0, $preload=FALSE)

	sendEmailToVendorAndAdmins ($subject=NULL, $message=NULL)

	displayLogos ($logo_list)

	renderPluginName ($plugin)

	getPluginHtml ($plugin, $selectedPlugin, $pluginSalesPrice)

	getHtmlHeaderBE ()

	getHtmlRow ($key, $value, $class= '')

	checkConditions ($cart, $method, $cart_prices)

	calculateSalesPrice ($cart, $method, $cart_prices)

	logInfo ($text, $type= 'message', $doLog=false)

Protected Member Functions inherited from vmPlugin
	selectedThis ($psType, $name=0, $jid=null)

	selectedThisByJPluginId ($jplugin_id= 'type')

	getJoomlaPluginId ()

	createTableSQL ($tableComment, $tablesFields=0)

	getTablePluginParams ($psType, $name, $id, &$xParams, &$varsToPush)

	setOnTablePluginParams ($name, $id, &$table)

	declarePluginParams ($psType, &$data, $blind=0, $blind2=0)

	getVmPluginMethod ($int, $cache=true)

	storePluginInternalData (&$values, $primaryKey=0, $id=0, $preload=FALSE)

	getPluginInternalData ($id, $primaryKey=0)

	createPluginTableObject ($tableName, $tableFields, $primaryKey, $tableId, $loggable=FALSE)

	removePluginInternalData ($id, $primaryKey=0)

Additional Inherited Members
Public Attributes inherited from vmPSPlugin
	$methods = null

Protected Attributes inherited from vmPSPlugin
	$_toConvert = false

Protected Attributes inherited from vmPlugin
	$_psType = 0

	$_jid = 0

	$_vmpItable = 0

	$_tablename = 0

	$_tableId = 'id'

	$_tablepkey = 0

	$_vmpCtable = 0

	$_configTable = 0

	$_configTableFileName = 0

	$_configTableClassName = 0

	$_xParams = 0

	$_varsToPushParam = array()

	$_idName = 0

	$_configTableFieldName = 0

	$_debug = FALSE

	$_loggable = FALSE

	$_cryptedFields = false

	$_toConvertDec = false

Constructor & Destructor Documentation

plgVmPaymentStandard::__construct	(	&	$subject,
			$config
	)

Member Function Documentation

plgVmPaymentStandard::checkConditions	(	$cart,
		$method,
		$cart_prices
	)

protected

Check if the payment conditions are fulfilled for this payment method

Author: : Valerie Isaksen

Parameters

$cart_prices	cart prices
$payment

Returns: true: if the conditions are fulfilled, false otherwise

plgVmPaymentStandard::getNewStatus ( $method )

static plgVmPaymentStandard::getPaymentCurrency	(	&	$method,
			$selectedUserCurrency = `false`
	)

static

plgVmPaymentStandard::getTableSQLFields ( )

Fields to create the payment table

Returns: string SQL Fileds

plgVmPaymentStandard::getVmPluginCreateTableSQL ( )

Create the table for this plugin if it does not yet exist.

Author: Valérie Isaksen

plgVmPaymentStandard::plgVmConfirmedOrder	(	$cart,
		$order
	)

Author: Valérie Isaksen

plgVmPaymentStandard::plgVmDeclarePluginParamsPaymentVM3 ( & $data )

plgVmPaymentStandard::plgVmDisplayListFEPayment	(	VirtueMartCart	$cart,
			$selected = `0`,
		&	$htmlIn
	)

plgVmDisplayListFEPayment This event is fired to display the pluginmethods in the cart (edit shipment/payment) for exampel

Parameters

object	$cart	Cart object
integer	$selected	ID of the method selected

Returns: boolean True on succes, false on failures, null when this plugin was not selected. On errors, JError::raiseWarning (or JError::raiseError) must be used to set a message.

Author: Valerie Isaksen; Max Milbers

plgVmPaymentStandard::plgVmgetEmailCurrency	(		$virtuemart_paymentmethod_id,
			$virtuemart_order_id,
		&	$emailCurrencyId
	)

Parameters

$virtuemart_paymentmethod_id
$paymentCurrencyId

Returns: bool|null

plgVmPaymentStandard::plgVmgetPaymentCurrency	(		$virtuemart_paymentmethod_id,
		&	$paymentCurrencyId
	)

plgVmPaymentStandard::plgVmOnCheckAutomaticSelectedPayment	(	VirtueMartCart	$cart,
		array	$cart_prices = `array()`,
		&	$paymentCounter
	)

plgVmOnCheckAutomaticSelectedPayment Checks how many plugins are available. If only one, the user will not have the choice. Enter edit_xxx page The plugin must check first if it is the correct type

Author: Valerie Isaksen

Parameters

VirtueMartCart cart: the cart object

Returns: null if no plugin was found, 0 if more then one plugin was found, virtuemart_xxx_id if only one plugin is found

plgVmPaymentStandard::plgVmOnSelectCheckPayment	(	VirtueMartCart	$cart,
		&	$msg
	)

This event is fired after the payment method has been selected. It can be used to store additional payment info in the cart.

Author: Max Milbers; Valérie isaksen

Parameters

VirtueMartCart $cart, the actual cart

Returns: null if the payment was not selected, true if the data is valid, error message if the data is not vlaid

plgVmPaymentStandard::plgVmonSelectedCalculatePricePayment	(	VirtueMartCart	$cart,
		array &	$cart_prices,
		&	$cart_prices_name
	)

plgVmPaymentStandard::plgVmOnShowOrderBEPayment	(	$virtuemart_order_id,
		$virtuemart_payment_id
	)

Display stored payment data for an order

plgVmPaymentStandard::plgVmOnShowOrderFEPayment	(		$virtuemart_order_id,
			$virtuemart_paymentmethod_id,
		&	$payment_name
	)

This method is fired when showing the order details in the frontend. It displays the method-specific data.

Parameters

integer $order_id The order ID

Returns: mixed Null for methods that aren't active, text (HTML) otherwise

Author: Max Milbers; Valerie Isaksen

plgVmPaymentStandard::plgVmonShowOrderPrintPayment	(	$order_number,
		$method_id
	)

This event is fired during the checkout process. It can be used to validate the method data as entered by the user.

Returns: boolean True when the data was valid, false otherwise. If the plugin is not activated, it should return null.

Author: Max Milbers

public function plgVmOnCheckoutCheckDataPayment( VirtueMartCart $cart) { return null; } This method is fired when showing when priting an Order It displays the the payment method-specific data.

Parameters

integer	$_virtuemart_order_id	The order ID
integer	$method_id	method used for this order

Returns: mixed Null when for payment methods that were not selected, text (HTML) otherwise

Author: Valerie Isaksen

plgVmPaymentStandard::plgVmOnStoreInstallPaymentPluginTable ( $jplugin_id )

Create the table for this plugin if it does not yet exist. This functions checks if the called plugin is active one. When yes it is calling the standard method to create the tables

Author: Valérie Isaksen

plgVmPaymentStandard::plgVmOnUserInvoice	(		$orderDetails,
		&	$data
	)

Parameters

$orderDetails
$data

Returns: null

plgVmPaymentStandard::plgVmSetOnTablePluginParamsPayment	(		$name,
			$id,
		&	$table
	)

The documentation for this class was generated from the following file:

plugins/vmpayment/standard/standard.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation