VirtueMart Forum

VirtueMart 2 + 3 + 4 => General Questions => Topic started by: apk on February 11, 2022, 23:14:19 PM

Title: Developer Manual?
Post by: apk on February 11, 2022, 23:14:19 PM
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.
Title: Re: Developer Manual?
Post by: jenkinhill on February 12, 2022, 12:23:00 PM
? http://docs.virtuemart.net/
Title: Re: Developer Manual?
Post by: apk on February 12, 2022, 20:57:44 PM
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 (https://dev.virtuemart.net/attachments/download/24/VirtueMart_1.1_Developer_Manual.pdf)

If that no longer exists then fair enough.
Title: Re: Developer Manual?
Post by: pinochico on February 12, 2022, 21:52:44 PM
yep, it was Soeren's time :)
that time is over
Title: Re: Developer Manual?
Post by: GJC Web Design on February 12, 2022, 22:16:04 PM
@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
Title: Re: Developer Manual?
Post by: Studio 42 on February 13, 2022, 16:12:33 PM
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


 
Title: Re: Developer Manual?
Post by: apk on February 16, 2022, 22:16:20 PM
Thanks for the pointers everyone.
Title: Re: Developer Manual?
Post by: Milbo on March 09, 2022, 17:49:17 PM
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.