vmCustomPlugin Class Reference

Inheritance diagram for vmCustomPlugin:

Collaboration diagram for vmCustomPlugin:

Public Member Functions
	__construct (&$subject, $config)
	onDisplayEditBECustom ($virtuemart_custom_id, &$customPlugin)
	parseCustomParams (&$field, $xParams= 'customfield_params')
	getCustomParams (&$field)
	OnStoreProduct ($data, $plugin_param)
	GetPluginInCart ($product)
	selectSearchableCustom (&$selectList)
	GetNameByCustomId ($custom_id)
	getIdForCustomIdProduct ($product_id, $custom_id)
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
	getPluginProductDataCustom (&$field, $product_id)
	getPluginCustomData (&$field, $product_id)
	storePluginInternalDataProduct (&$values, $primaryKey=0, $product_id=0)
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)

Protected Attributes
	$customs
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

Additional Inherited Members
Static Public Member Functions inherited from vmPlugin
static	loadJLang ($fname, $type, $name)
static	getVarsToPushFromForm ($form)
static	getVarsToPushByXML ($xmlFile, $name)

Constructor & Destructor Documentation

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

Member Function Documentation

vmCustomPlugin::getCustomParams

(

&

$field

)

vmCustomPlugin::getIdForCustomIdProduct	(		$product_id,
			$custom_id
	)

render the plugin with param to display on product edit called by customfields inputTypePlugin

vmCustomPlugin::GetNameByCustomId

(

$custom_id

)

render the plugin with param to display on product edit called by customfields inputTypePlugin render the plugin with param to display on product edit called by customfields inputTypePlugin

vmCustomPlugin::getPluginCustomData ( &  $field,   $product_id  )

protected

helper to get plugin table as object All params are added to $this->params plugin

Parameters

unknown_type	$field
unknown_type	$product_id

vmCustomPlugin::GetPluginInCart

(

$product

)

convert param for render and display The plugin in cart return null if not $this->_name

vmCustomPlugin::getPluginProductDataCustom ( &  $field,   $product_id  )

protected

Helper to add all params of specific product of this custom to an object

Parameters

object	$field
int	$product_id

vmCustomPlugin::onDisplayEditBECustom	(		$virtuemart_custom_id,
		&	$customPlugin
	)

vmCustomPlugin::OnStoreProduct	(		$data,
			$plugin_param
	)

This is the actions which take place, when a product gets stored

Parameters

string	$type	atm valid 'product'
array	$data	form data
int	$id	virtuemart_product_id

vmCustomPlugin::parseCustomParams	(	&	$field,
			$xParams = 'customfield_params'
	)

vmCustomPlugin::selectSearchableCustom

(

&

$selectList

)

render the plugin with param to display on product edit called by customfields inputTypePlugin

vmCustomPlugin::storePluginInternalDataProduct ( &  $values,   $primaryKey = 0,   $product_id = 0  )

protected

This stores the data of the plugin, attention NOT the configuration of the pluginmethod, this function should never be triggered only called from triggered functions.

Author

Max Milbers

Parameters

array	$values	array or object with the data to store
string	$tableName	When different then the default of the plugin, provid it here
string	$tableKey	an additionally unique key

Member Data Documentation

vmCustomPlugin::$customs

protected

---

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

• administrator/components/com_virtuemart/plugins/vmcustomplugin.php