[ENHANCEMENT]: Standard module does not have a modulelayout field

SimonvanDoorne commented

2025-08-28 14:36:37 +00:00

Member

Enhancement Details

There is currently no option for selecting a template. I understand that JCB only creates a single view and so a selector isn't needed. The only problem is when we install a module on different sites with different templates we need 2 different versions since we can't make an override and select it. The "modulelayout" field does exactly what i want, which only needs a little styling (which i could do if that would quicken adding it).

Which part of the extension will be affected by this enhancement?

Compilation of component, Joomla Modules(admin_views), Joomla Module(admin_view)

Additional Context

After compiling a module, you cannot select different layout in the module. A usecase for why i'm asking for this to be added:
We have a form component where we have a custom form builder for a client. They need some specific logic that is difficult to add with regular form components like chronoforms or rsforms. Currently the client has 2 sites, with different versions of Joomla, and different templates. One uses bootstrap and the other using UIKit. This has no clean solution since we either need 2 modules (creates issues with having to update 2 versions) or we have 1 view with 2 complete views in it, 1 for each template. Apart from this single client we want to implement our form builder on other sites since we're moving away from standard form generators since they often create issues with upgrading Joomla versions. An issue JCB neatly solves!

### Enhancement Details There is currently no option for selecting a template. I understand that JCB only creates a single view and so a selector isn't needed. The only problem is when we install a module on different sites with different templates we need 2 different versions since we can't make an override and select it. The "modulelayout" field does exactly what i want, which only needs a little styling (which i could do if that would quicken adding it). ### Which part of the extension will be affected by this enhancement? Compilation of component, Joomla Modules(admin_views), Joomla Module(admin_view) ### Additional Context After compiling a module, you cannot select different layout in the module. A usecase for why i'm asking for this to be added: We have a form component where we have a custom form builder for a client. They need some specific logic that is difficult to add with regular form components like chronoforms or rsforms. Currently the client has 2 sites, with different versions of Joomla, and different templates. One uses bootstrap and the other using UIKit. This has no clean solution since we either need 2 modules (creates issues with having to update 2 versions) or we have 1 view with 2 complete views in it, 1 for each template. Apart from this single client we want to implement our form builder on other sites since we're moving away from standard form generators since they often create issues with upgrading Joomla versions. An issue JCB neatly solves!

SimonvanDoorne added the enhancement label 2025-08-28 14:36:37 +00:00

Llewellyn commented

2025-08-29 00:27:48 +00:00

Owner

This sounds like a great idea... give me a module. Basic one, that has this feature coded into it, and I will see what we can do.

SimonvanDoorne commented

2025-08-29 16:48:48 +00:00

Author

Member

The module mod_login uses the modulelayout field.
In the xml:

			<field
				name="layout"
				type="modulelayout"
				label="JFIELD_ALT_LAYOUT_LABEL"
				class="form-select"
				validate="moduleLayout"
			/>

The 'old' J3 modules that come with base joomla still calls the layout like this:

$layout = $params->get('layout', 'default');

// Logged users must load the logout sublayout
if (!$user->guest) {
    $layout .= '_logout';
}


require ModuleHelper::getLayoutPath('mod_login', $layout);

While the mod_custom uses the dispatcher, which funny enough still ends up calling the same logic:

require ModuleHelper::getLayoutPath($module->module, $params->get('layout', 'default'));

This is done in libraries/src/Dispatcher/AbstractModuleDispatcher.php

The module mod_login uses the modulelayout field. In the xml: <field name="layout" type="modulelayout" label="JFIELD_ALT_LAYOUT_LABEL" class="form-select" validate="moduleLayout" /> ![afbeelding.png](/attachments/fc4823f6-8561-4b06-b99a-2f075abbb972) The 'old' J3 modules that come with base joomla still calls the layout like this: ``` $layout = $params->get('layout', 'default'); // Logged users must load the logout sublayout if (!$user->guest) { $layout .= '_logout'; } require ModuleHelper::getLayoutPath('mod_login', $layout); ``` While the mod_custom uses the dispatcher, which funny enough still ends up calling the same logic: `require ModuleHelper::getLayoutPath($module->module, $params->get('layout', 'default'));` This is done in libraries/src/Dispatcher/AbstractModuleDispatcher.php

afbeelding.png

9.8 KiB

Llewellyn commented

2025-09-03 20:06:52 +00:00

Owner

We have now added the new Module builder in https://github.com/joomengine/pkg-component-builder/archive/refs/heads/5.x.zip

You will see the new architecture towards Joomla 5 native... please test it a little, and let me know. I am sure we can add this option to the modules.

So if you build a module and add the extra xml to the module manually, does it work. This will help me, since I am working on other parts in JCB at this time, and you ironing out this will help.

We have now added the new Module builder in https://github.com/joomengine/pkg-component-builder/archive/refs/heads/5.x.zip You will see the new architecture towards Joomla 5 native... please test it a little, and let me know. I am sure we can add this option to the modules. So if you build a module and add the extra xml to the module *manually*, does it work. This will help me, since I am working on other parts in JCB at this time, and you ironing out this will help.

SimonvanDoorne commented

2025-09-06 10:49:02 +00:00

Author

Member

So far it seems to work like charm! I created a new component and a new module with the version you linked. Added the field like i described in my first comment.

Adding the layout field it auto detects all views in the module tmpl folder and from the template overrides.
Selecting the different views loads the correct php file. Havent had time yet to fully test any edge cases but so far it looks good!

So far it seems to work like charm! I created a new component and a new module with the version you linked. Added the field like i described in my first comment. ![afbeelding.png](/attachments/560ffb7a-66ce-4033-8819-fcc5f58019a3) Adding the layout field it auto detects all views in the module tmpl folder and from the template overrides. Selecting the different views loads the correct php file. Havent had time yet to fully test any edge cases but so far it looks good!

afbeelding.png

17 KiB

Llewellyn commented

2025-09-19 12:59:26 +00:00

Owner

This location in the code tab of a module:

The code:

$data['user'] = $data['app']->getIdentity();
$data['layout'] = $data['params']->get('layout', 'default');

// Logged users must load the logout sublayout
if (!$data['user']->guest)
{
	$data['layout'] .= '_your_custom_layout_in_jcb_logout';
	$data['params']->set('layout', $data['layout']);
	// to load the template
	// $this->loadTemplate('your_custom_layout_in_jcb_logout');

	// you can link multiple templates to a module
	// $this->loadTemplate('other_template');
	// $this->loadTemplate('yet_another_template');
}

But we have also added the extra xml details to the module 👍 in v5.1.2-beta3 (will be out later today)

Just as a side note, you can/could actually add your own advance fields to your module, which will then stop JCB from loading it, and cause it to be loaded as per your field settings. So not adding a config->params->advance field set, JCB will now add it for you.

This way:

This location in the code tab of a module: ![image.png](https://git.vdm.dev/attachments/07e12fff-dd23-4e38-b175-53b4b80a6f16) The code: ```php $data['user'] = $data['app']->getIdentity(); $data['layout'] = $data['params']->get('layout', 'default'); // Logged users must load the logout sublayout if (!$data['user']->guest) { $data['layout'] .= '_your_custom_layout_in_jcb_logout'; $data['params']->set('layout', $data['layout']); // to load the template // $this->loadTemplate('your_custom_layout_in_jcb_logout'); // you can link multiple templates to a module // $this->loadTemplate('other_template'); // $this->loadTemplate('yet_another_template'); } ``` **But we have also added** the extra xml details to the module 👍 in **v5.1.2-beta3** (will be out later today) Just as a side note, you can/could actually add your own advance fields to your module, which will then stop JCB from loading it, and cause it to be loaded as per your field settings. So not adding a `config->params->advance` field set, JCB will now add it for you. This way: ![image.png](https://git.vdm.dev/attachments/5d246a96-7000-49c7-9bc7-47b628288d87)

image.png

90 KiB

image.png

40 KiB