News:

Support the VirtueMart project and become a member

Main Menu

Developer Manual?

Started by apk, February 11, 2022, 23:14:19 PM

Previous topic - Next topic

apk

Hi, just a quick question.
Is there any documentation on how Virtuemart works from a developer/designer perspective?
I am particularly looking for an up to date document describing the main directory hierarchy, the major functions and data structures and how the code hangs together.
The links I have found through the Virtuemart site including the trunk on the code download section appear to be 12 years old and reference directories which are no long there.

jenkinhill

Kelvyn
Lowestoft, Suffolk, UK

Retired from forum life November 2023

Please mention your VirtueMart, Joomla and PHP versions when asking a question in this forum

apk

Quote from: jenkinhill on February 12, 2022, 12:23:00 PM
? http://docs.virtuemart.net/

This isn't what I'm looking for. That appears to be a series of user manuals and an incomplete API document.
I had hoped to modify some code and was looking for a manual which would describe the actual code itself.
Something a bit like this out of date document here:-
https://dev.virtuemart.net/attachments/download/24/VirtueMart_1.1_Developer_Manual.pdf

If that no longer exists then fair enough.

pinochico

yep, it was Soeren's time :)
that time is over
www.minijoomla.org  - new portal for Joomla!, Virtuemart and other extensions
XML Easy Feeder - feeds for FB, GMC,.. from products, categories, orders, users, articles, acymailing subscribers and database table
Virtuemart Email Manager - customs email templates
Import products for Virtuemart - from CSV and XML
Rich Snippets - Google Structured Data
VirtueMart Products Extended - Slider with products, show Others bought, Products by CF ID and others filtering products

GJC Web Design

@apk VM is very cleanly and logically written -- if you know Model–view–controller (MVC) software design patterns and are familiar with Joomla component design you will have no problem finding your way around.

What is a little different is that all models are in the admin .. even for all frontend functions .. there is a range of helpers as well ... but all logically named
GJC Web Design
VirtueMart and Joomla Developers - php developers https://www.gjcwebdesign.com
VM4 AusPost Shipping Plugin - e-go Shipping Plugin - VM4 Postcode Shipping Plugin - Radius Shipping Plugin - VM4 NZ Post Shipping Plugin - AusPost Estimator
Samport Payment Plugin - EcomMerchant Payment Plugin - ccBill payment Plugin
VM2 Product Lock Extension - VM2 Preconfig Adresses Extension - TaxCloud USA Taxes Plugin - Virtuemart  Product Review Component
https://extensions.joomla.org/profile/profile/details/67210
Contact for any VirtueMart or Joomla development & customisation

Studio 42

The front end helpers are in front(cart, coupon....)
All shared helpers are in admin
The models are in admin only to gain code size but is used in front because you can use same fonction in front (as shop owner, admin ...)
parent VIrtuemart Joomla plugins classes are in admin/plugins


 

apk

Thanks for the pointers everyone.

Milbo

here is the a bit outdated developer manual https://dev.virtuemart.net/projects/virtuemart/wiki

and here are some explanations. https://docs.virtuemart.net/tutorials/development.html

The rest is often like joomla, but from my point of view more obvious. Joomla changed their stile also to be more obvious.

and this helps also a lot to understand VM better https://docs.virtuemart.net/manual/general-concepts.html

also interesting https://docs.virtuemart.net/tutorials/templating-layouts.html

and that one is outdated :-( https://api.virtuemart.net/
I tried to update it once, but I stopped after some hours.
Should I fix your bug, please support the VirtueMart project and become a member
______________________________________
Extensions approved by the core team: http://extensions.virtuemart.net/