Inheritance diagram for plgVmShipmentWeight_countries:

Collaboration diagram for plgVmShipmentWeight_countries:

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

	getVmPluginCreateTableSQL ()

	getTableSQLFields ()

	plgVmOnShowOrderFEShipment ($virtuemart_order_id, $virtuemart_shipmentmethod_id, &$shipment_name)

	plgVmConfirmedOrder (VirtueMartCart $cart, $order)

	plgVmOnShowOrderBEShipment ($virtuemart_order_id, $virtuemart_shipmentmethod_id)

	getOrderShipmentHtml ($virtuemart_order_id)

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

	convert (&$method)

	plgVmOnProductDisplayShipment ($product, &$productDisplayShipments)

	plgVmOnStoreInstallShipmentPluginTable ($jplugin_id)

	plgVmOnSelectCheckShipment (VirtueMartCart &$cart)

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

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

	plgVmOnCheckAutomaticSelectedShipment (VirtueMartCart $cart, array $cart_prices, &$shipCounter)

	plgVmOnCheckoutCheckDataShipment (VirtueMartCart $cart)

	plgVmonShowOrderPrint ($order_number, $method_id)

	plgVmDeclarePluginParamsShipment ($name, $id, &$dataOld)

	plgVmDeclarePluginParamsShipmentVM3 (&$data)

	plgVmSetOnTablePluginShipment (&$data, &$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')

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)

Private Member Functions
	_nbproductsCond ($cart, $method)

	testRange ($value, $method, $floor, $ceiling, $name)

Additional Inherited Members
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)

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

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

Parameters

object	$subject
array	$config

Member Function Documentation

plgVmShipmentWeight_countries::_nbproductsCond	(	$cart,
		$method
	)

private

Parameters

$cart
$method

Returns: bool

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

protected

Parameters

\VirtueMartCart	$cart
int	$method
array	$cart_prices

Returns: bool

plgVmShipmentWeight_countries::convert ( & $method )

Parameters

$method

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

Parameters

VirtueMartCart	$cart
	$method
	$cart_prices

Returns: int

plgVmShipmentWeight_countries::getOrderShipmentHtml ( $virtuemart_order_id )

Parameters

$virtuemart_order_id

Returns: string

plgVmShipmentWeight_countries::getTableSQLFields ( )

Returns: array

plgVmShipmentWeight_countries::getVmPluginCreateTableSQL ( )

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

Author: Valérie Isaksen

plgVmShipmentWeight_countries::plgVmConfirmedOrder	(	VirtueMartCart	$cart,
			$order
	)

This event is fired after the order has been stored; it gets the shipment method- specific data.

Parameters

int	$order_id	The order_id being processed
object	$cart	the cart
array	$order	The actual order saved in the DB

Returns: mixed Null when this method was not selected, otherwise true

Author: Valerie Isaksen

plgVmShipmentWeight_countries::plgVmDeclarePluginParamsShipment	(		$name,
			$id,
		&	$dataOld
	)

plgVmShipmentWeight_countries::plgVmDeclarePluginParamsShipmentVM3 ( & $data )

plgVmShipmentWeight_countries::plgVmDisplayListFEShipment	(	VirtueMartCart	$cart,
			$selected = `0`,
		&	$htmlIn
	)

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

Parameters

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

Returns: boolean True on success, 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

plgVmShipmentWeight_countries::plgVmOnCheckAutomaticSelectedShipment	(	VirtueMartCart	$cart,
		array	$cart_prices,
		&	$shipCounter
	)

plgVmOnCheckAutomaticSelected 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

plgVmShipmentWeight_countries::plgVmOnCheckoutCheckDataShipment ( VirtueMartCart $cart )

plgVmShipmentWeight_countries::plgVmOnProductDisplayShipment	(		$product,
		&	$productDisplayShipments
	)

plgVmShipmentWeight_countries::plgVmOnSelectCheckShipment ( VirtueMartCart & $cart )

Parameters

VirtueMartCart $cart

Returns: null

plgVmShipmentWeight_countries::plgVmOnSelectedCalculatePriceShipment	(	VirtueMartCart	$cart,
		array &	$cart_prices,
		&	$cart_prices_name
	)

Parameters

VirtueMartCart	$cart
array	$cart_prices
	$cart_prices_name

Returns: bool|null

plgVmShipmentWeight_countries::plgVmOnShowOrderBEShipment	(	$virtuemart_order_id,
		$virtuemart_shipmentmethod_id
	)

This method is fired when showing the order details in the backend. It displays the shipment-specific data. NOTE, this plugin should NOT be used to display form fields, since it's called outside a form! Use plgVmOnUpdateOrderBE() instead!

Parameters

integer	$virtuemart_order_id	The order ID
integer	$virtuemart_shipmentmethod_id	The order shipment method ID

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

Author: Valerie Isaksen

plgVmShipmentWeight_countries::plgVmOnShowOrderFEShipment	(		$virtuemart_order_id,
			$virtuemart_shipmentmethod_id,
		&	$shipment_name
	)

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

Parameters

integer	$virtuemart_order_id	The order ID
integer	$virtuemart_shipmentmethod_id	The selected shipment method id
string	$shipment_name	Shipment Name

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

Author: Valérie Isaksen; Max Milbers

plgVmShipmentWeight_countries::plgVmonShowOrderPrint	(	$order_number,
		$method_id
	)

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

plgVmShipmentWeight_countries::plgVmOnStoreInstallShipmentPluginTable ( $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

plgVmShipmentWeight_countries::plgVmSetOnTablePluginShipment	(	&	$data,
		&	$table
	)

Author: Max Milbers

Parameters

$data
$table

Returns: bool

plgVmShipmentWeight_countries::testRange	(	$value,
		$method,
		$floor,
		$ceiling,
		$name
	)

private

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

plugins/vmshipment/weight_countries/weight_countries.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation