vmExtendedPlugin Class Reference

Inheritance diagram for vmExtendedPlugin:

Collaboration diagram for vmExtendedPlugin:

Public Member Functions
	__construct (&$subject, $config=array())
	onVmAdminController ($controller)
	onVmSiteController ($controller)
	onVmSqlRemove (&$updater)
	onVmSqlRestore (&$updater)
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')

Public Attributes
	$_name = ''

Protected Member Functions
	getName ()
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
	$_path = ''
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

vmExtendedPlugin::__construct	(	&	$subject,
			$config = array()
	)

Constructor

Parameters

object	$subject	The object to observe
array	$config	An array that holds the plugin configuration

Member Function Documentation

vmExtendedPlugin::getName ( )

protected

Method to get the plugin name

The plugin name parsed using the classname (adapted from Joomla's JModel)

Returns

string The name of the plugin

vmExtendedPlugin::onVmAdminController

(

$controller

)

Plugs into the backend controller logic to insert a custom controller into the VM component space This means that links can be constructed as index.php?option=com_virtuemart&view=myaddon and work

Parameters

string

$controller

Name of controller requested

Returns

True if this loads a file (null otherwise)

vmExtendedPlugin::onVmSiteController

(

$controller

)

Plugs into the frontend controller logic to insert a custom controller into the VM component space This means that links can be constructed as index.php?option=com_virtuemart&view=myaddon and work

Parameters

string

$controller

Name of controller requested

Returns

True if this loads a file (null otherwise)

vmExtendedPlugin::onVmSqlRemove

(

&

$updater

)

Plugs into the updater model to remove additional VM data (useful if the plugin depends on fields in a VM table)

Parameters

object

$updater

VirtueMartModelUpdatesMigration object

vmExtendedPlugin::onVmSqlRestore

(

&

$updater

)

Plugs into the updater model to reinstall additional VM data (useful if the plugin depends on fields in a VM table)

Parameters

object

$updater

VirtueMartModelUpdatesMigration object

Member Data Documentation

vmExtendedPlugin::$_name = ''

vmExtendedPlugin::$_path = ''

protected

---

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

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