VirtueMart

https://docs.virtuemart.net
Admin
VirtueMart is a fully featured and open-source ecommerce system, integrating with Joomla to provide...
Tokens:114,106
Snippets:1,272
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Language File Entry Example

Source: https://docs.virtuemart.net/manual/general-concepts/multilanguage-and-multlingual

Example of a language key and its corresponding display text as found in a VirtueMart language file.

```ini
COM_VIRTUEMART_CART_ADD_TO="Add to Cart"
```

--------------------------------

### Configure svn.dir in config.properties

Source: https://docs.virtuemart.net/tutorials/development/svn-download

Example configuration for the svn.dir property pointing to the local checkout directory.

```properties
svn.dir = C:/joomla/VirtueMart/svn/virtuemart
```

--------------------------------

### Core Asset Path Example

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-the-vm-javascript-handler

The default path for a core JavaScript module when no override exists.

```text
media/com_virtuemart/js/product/vmprices.module.js
```

--------------------------------

### Loading Assets with vmJsApi

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-the-vm-javascript-handler

Examples of using the three primary vmJsApi methods to load modules, inline scripts, and stylesheets.

```php
vmJsApi::addvScriptModule('be/myfeature.module');
vmJsApi::addJScript('my-inline', 'window.Virtuemart = window.Virtuemart || {};');
vmJsApi::css('glightbox');
```

--------------------------------

### Override Site CSS

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-media-com-virtuemart-overrides

Example path for overriding the site CSS file in the Cassiopeia template.

```text
media/templates/site/cassiopeia/css/com_virtuemart/vm-ltr-site.css
```

--------------------------------

### Implement UI state with Alpine.js in HTML

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-why-alpine-js-interactivity-in-html-for-templates

A simple example demonstrating how to manage visibility state using x-data, @click, and x-show attributes without requiring a separate JavaScript file.

```html
<div x-data="{ open: false }">
	<button type="button" @click="open = !open">
		Toggle details
	</button>
	<div x-show="open" x-cloak>
		Your custom block — only visible when open is true.
	</div>
</div>
```

--------------------------------

### Registering plugins with VMInit reInit options

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-our-new-javascript-registration-system-vm-init-registry

Examples of registering plugins with reInit set to true for automatic AJAX updates or false for one-shot initialization.

```javascript
// Typical plugin: bind UI, survive cart / product AJAX automatically
VMInit.add('MyPlugin Feature', initMyFeature, 550, {
	reInit: true   // default — keep it true for DOM / UI work
});

// One-shot only
VMInit.add('MyPlugin Bootstrap', initOnce, 550, {
	reInit: false
});
```

--------------------------------

### Registering scripts, modules, and CSS with vmJsApi

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-vmjsapi-es-modules-dual-load

Example of how to register an ES module, a classic inline script, and a CSS file using the vmJsApi methods.

```php
vmJsApi::addvScriptModule('be/myfeature.module');
vmJsApi::addJScript('my-inline', 'window.Virtuemart = window.Virtuemart || {};');
vmJsApi::css('choices.min');
```

--------------------------------

### Configuring plugin parameters with vmPlugin

Source: https://docs.virtuemart.net/virtuemart-technics/why-you-should-use-vmplugin

Demonstrates how to use vmPlugin methods to push configuration variables, set parameter handling, and define fields for currency conversion.

```php
$varsToPush = $this->getVarsToPush ();  
$this->addVarsToPushCore($varsToPush,1);  
$this->setConfigParameterable ($this->_configTableFieldName, $varsToPush);  
$this->setConvertable(array('min_amount','max_amount','cost_per_transaction','cost_min_transaction'));
```

--------------------------------

### Broken relative import example

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-media-com-virtuemart-overrides

An example of a relative import that fails when overriding a module because it resolves relative to the override file rather than the core file.

```javascript
import vmInitRegistry from '../vm-init-registry.module.js';
```

--------------------------------

### VMInit.addPlugin(name, callback, options)

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-our-new-javascript-registration-system-vm-init-registry

A shortcut method for registering plugin-specific initialization logic with default high-priority settings.

```APIDOC
## VMInit.addPlugin(name, callback, options)

### Description
Registers a plugin initialization function with default priority (800) and retry (8) settings, ensuring execution after core processes.

### Parameters
- **name** (string) - Required - A unique identifier for the plugin.
- **callback** (function) - Required - The function to execute for initialization.
- **options** (object) - Optional - Configuration object:
  - **priority** (number) - Override default priority.
  - **retry** (number) - Override default retry count.
  - **reInit** (boolean) - Whether to re-initialize after AJAX events.
```

--------------------------------

### Template Override Path Example

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-the-vm-javascript-handler

The path structure for a template override of a JavaScript module.

```text
media/templates/site/cassiopeia/js/com_virtuemart/product/vmprices.module.js
```

--------------------------------

### VMInit.run(isReInit)

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-our-new-javascript-registration-system-vm-init-registry

Executes the sorted initialization queue.

```APIDOC
## VMInit.run(isReInit = false)

### Description
Runs the sorted queue of initialization functions. Typically called by VirtueMart at the end of the page load. If isReInit is true, tasks with reInit: false are skipped.
```

--------------------------------

### Override Image Asset

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-media-com-virtuemart-overrides

Example path for overriding an image asset used through setPath in the Cassiopeia template.

```text
media/templates/site/cassiopeia/images/com_virtuemart/vm-preloader.gif
```

--------------------------------

### Initialize Alpine.js Manually

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-why-alpine-js-interactivity-in-html-for-templates

Checks if Alpine is already started before calling VMInit.startAlpine() to ensure proper initialization.

```javascript
	if (!VMInit._alpineStarted) {
		VMInit.startAlpine();
	}
```

--------------------------------

### VMInit.addPlugin(name, initFn, options)

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-our-new-javascript-registration-system-vm-init-registry

A convenience wrapper for VMInit.add with plugin-specific defaults.

```APIDOC
## VMInit.addPlugin(name, initFn, options = {})

### Description
Registers a plugin task with default priority 800 and retry count 8. Priority can be overridden via the options object.
```

--------------------------------

### Calculate manufacturer cell width

Source: https://docs.virtuemart.net/tutorials/development/php-basics-for-templater

A practical example of using configuration values and conditional logic to determine layout properties.

```php
// Calculating Manufacturers Per Row
$manufacturerPerRow = VmConfig::get ('manufacturer_per_row', 3);
if ($manufacturerPerRow > 1) {
	$manufacturerCellWidth = ' width'.floor ( 100 / $manufacturerPerRow );
} else {
	$manufacturerCellWidth = '';
}
```

--------------------------------

### Update checkConditions Function

Source: https://docs.virtuemart.net/tutorials/development/236-update-payment-shipment-plugin-using-new-core-restrictions.html

Example of overriding checkConditions to handle custom restrictions while calling the parent function for core restrictions.

```php
protected function checkConditions($cart, $activeMethod, $cart_prices) {  
  
   //Check method publication start  
   if ($activeMethod->publishup) {  
      $nowDate = JFactory::getDate();  
      $publish_up = JFactory::getDate($activeMethod->publishup);  
      if ($publish_up->toUnix() > $nowDate->toUnix()) {  
         return FALSE;  
      }  
   }  
   if ($activeMethod->publishdown) {  
      $nowDate = JFactory::getDate();  
      $publish_down = JFactory::getDate($activeMethod->publishdown);  
      if ($publish_down->toUnix() <= $nowDate->toUnix()) {  
         return FALSE;  
      }  
   }  
  
   return parent::checkConditions($cart, $activeMethod, $cart_prices);  
}
```

--------------------------------

### Best practice for loading VirtueMart configuration

Source: https://docs.virtuemart.net/tutorials/development/how-to-fix-fatal-error-cannot-declare-class-name-is-already-in-use

A robust implementation that checks for the existence of the configuration file before loading it, or handles the absence of VirtueMart gracefully.

```php
if (file_exists(JPATH_ROOT.DS.'administrator/components/com_virtuemart/helpers/config.php')) {  
   if (!class_exists( 'VmConfig' )) require(JPATH_ROOT .'/administrator/components/com_virtuemart/helpers/config.php');  
   VmConfig::loadConfig();  
} else {  
   $app = JFactory::getApplication();  
   $app->enqueueMessage('Virtuemart not installed for'.get_class($this).', return','error');  
   return false;  
}
```

--------------------------------

### Language File Entries for Dynamic Messages

Source: https://docs.virtuemart.net/manual/general-concepts/multilanguage-and-multlingual

The language file entries required to support the dynamic message generation example.

```ini
COM_VIRTUEMART_STRING_SAVED="%s successfully saved"  
COM_VIRTUEMART_CONTROLLER_PRODUCT="Product(s)"
```

--------------------------------

### Register third-party libraries via PHP

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-our-new-javascript-registration-system-vm-init-registry

Use vmJsApi to load the library script and the globalizer module in PHP.

```php
// 1) Start download early (classic script tag / header)
vmJsApi::addJScript('mylib/mylib.min', false, false, true);

// 2) Globalizer module: import + window.XXX + VMInit signal
vmJsApi::addvScriptModule('mylib/mylib-global', 'plugins/.../assets/js');
```

--------------------------------

### VirtueMart Language Database Tables

Source: https://docs.virtuemart.net/manual/general-concepts/multilanguage-and-multlingual

List of standard VirtueMart database tables created for the English (en_gb) language during installation.

```sql
#_virtuemart_categories_en_gb  
#_virtuemart_manufacturercategories_en_gb  
#_virtuemart_manufacturers_en_gb  
#_virtuemart_paymentmethods_en_gb  
#_virtuemart_products_en_gb  
#_virtuemart_shipmentmethods_en_gb  
#_virtuemart_vendors_en_gb
```

--------------------------------

### Writing idempotent initialization code

Source: https://docs.virtuemart.net/virtuemart-technics/virtuemart5-our-new-javascript-registration-system-vm-init-registry

An example of an idempotent function that checks for existing initialization flags to prevent duplicate event listeners.

```javascript
function initMyFeature() {
	document.querySelectorAll('.js-my-feature').forEach((el) => {
		if (el.dataset.myFeatureInit) return;
		el.dataset.myFeatureInit = '1';
		el.addEventListener('click', onClick);
	});
}
```
Tokens:
Raw