JEM Quickicon Plugin

Plugin name: JEM - Quick Icon Plugin
Extension: plg_quickicon_jem
Plugin group: Quick Icon
Current versions: JEM 5.0.1, JEM 5.0.2 Beta 1 and JEM 5.1.0 Beta 4
Joomla compatibility: Joomla 5.4.x and Joomla 6.x

Overview

The JEM Quick Icon Plugin adds a JEM shortcut to the Joomla administrator dashboard. It gives authorised administrators direct access to the JEM backend and can also provide a shortcut for creating a new event.

This is an administrator convenience plugin. It does not change frontend event output, registrations, maps, modules, event data or database content.

Compatibility

JEM versionStatusSupported Joomla versionsQuick Icon behaviour
JEM 5.0.1 Stable Joomla 5.4.x and Joomla 6.x Displays the JEM administrator shortcut.
JEM 5.0.2 Beta 1 Beta Joomla 5.4.x and Joomla 6.x Same functional behaviour as JEM 5.0.1.
JEM 5.1.0 Beta 4 Beta Joomla 5.4.x and Joomla 6.x Same Quick Icon contract, using the current JEM 5.1 package metadata.
Compatibility limit: The installer accepts Joomla versions from 5.4.0 up to, but not including, Joomla 7. Joomla versions older than 5.4 are rejected by the installer script.

Requirements

  • Joomla 5.4.x or Joomla 6.x.
  • A compatible JEM component installed.
  • The JEM - Quick Icon Plugin enabled.
  • The Joomla administrator dashboard must contain a Quick Icons module.
  • The administrator user must have core.manage permission for com_jem.

Plugin Options

This plugin has no configurable parameters. Its link, icon and visibility conditions are defined by the plugin.

What the Plugin Adds

PropertyValuePurpose
Label JEM Events The translated name displayed by the Joomla Quick Icons module.
Main link index.php?option=com_jem Opens the JEM Control Panel.
Add-event link index.php?option=com_jem&task=event.add Provides a secondary create-event action when the Joomla Quick Icons module or administrator template renders secondary actions.
Icon icon-calendar Uses Joomla's administrator calendar icon.
Quick Icon ID plg_quickicon_jem Uniquely identifies the JEM dashboard item.

Visibility and Permissions

The plugin returns the JEM quick icon only when both conditions are met:

  • The active Quick Icon context is exactly mod_quickicon.
  • The current administrator user has core.manage permission for com_jem.

If either condition fails, the plugin returns no dashboard icon. Hiding the icon does not disable JEM itself; it only removes this dashboard shortcut.

Permission distinction: Permission to see the JEM quick icon is not the same as permission to create an event. The direct add-event URL is still checked by the JEM event controller and the applicable component, category and resource permissions.
User situationQuick iconCreate-event action
Super User Visible Normally allowed.
User with JEM manage and event-create permissions Visible Allowed for authorised JEM resources.
User with JEM manage permission but without event-create permission Visible The create request remains subject to JEM ACL and may be rejected.
User without JEM manage permission Not returned by the plugin Not available through this quick icon.

Installation and Update Behaviour

The installer validates the Joomla version using the following range:

JVERSION >= 5.4.0
JVERSION < 7.0.0

After a new installation or a discover installation, the installer enables the plugin automatically in Joomla's extensions table.

A normal update does not force-enable the plugin again. Therefore, if an administrator has deliberately disabled the plugin, that choice is preserved during an update.

How to Enable or Disable the Plugin

  1. Open the Joomla administrator area.
  2. Go to System → Manage → Plugins.
  3. Search for JEM - Quick Icon Plugin.
  4. Publish or unpublish the plugin as required.
  5. Return to the administrator dashboard and refresh the page.

Changing the Displayed Label

The plugin has no label parameter, but the displayed text can be customised with a Joomla language override.

  1. Go to System → Manage → Language Overrides.
  2. Select the administrator language.
  3. Create an override for:
PLG_QUICKICON_JEM_EVENTS

For example, the label could be changed from:

JEM Events

to:

Event Management

This changes only the translated dashboard label. It does not alter the plugin ID, URL or permissions.

Usage Examples

Example 1: Standard administrator access

A Super User signs in to Joomla and sees the JEM Events shortcut on the administrator dashboard. Clicking it opens the JEM Control Panel.

Example 2: Delegated event manager

A Joomla user group is granted permission to access JEM and create events only in selected JEM categories. The user can see the JEM dashboard shortcut, but JEM still limits event creation to the authorised categories and resources.

Example 3: Custom administrator dashboard

An administrator dashboard does not contain a Quick Icons module. The JEM plugin may be enabled and the user may have permission, but no JEM icon is displayed because Joomla never requests icons using the mod_quickicon context.

Technical Structure

File or directoryPurpose
jem.xml Defines the plugin manifest, namespace, files, languages, version and installer script.
jem.php Compatibility entry file retained so Joomla recognises the extension. Runtime creation is handled by the service provider.
services/provider.php Registers the namespaced plugin class through Joomla's dependency injection container.
src/Extension/Jem.php Contains the active plugin class and its onGetIcons() implementation.
script.php Checks Joomla compatibility and enables the plugin after install or discover install.
language/en-GB Contains the plugin name, description and quick icon label.

Verification Checklist

  1. Confirm that the plugin is published.
  2. Confirm that the dashboard contains an enabled Quick Icons module.
  3. Sign in with a user who has core.manage for com_jem.
  4. Verify that the JEM Events icon is displayed.
  5. Click the main icon and confirm that the JEM Control Panel opens.
  6. If the add action is rendered, confirm that authorised users can create an event.
  7. Repeat the test with a user without JEM access and confirm that the icon is absent.

Troubleshooting

ProblemPossible causeSuggested action
The JEM quick icon is not visible. The plugin is disabled, the dashboard has no Quick Icons module, or the user lacks core.manage for JEM. Enable the plugin, check the administrator dashboard modules and review the user's JEM component permissions.
The plugin is enabled, but no icon appears on a custom dashboard. The custom dashboard is not using the mod_quickicon context. Add or enable Joomla's Quick Icons administrator module on that dashboard.
The icon opens JEM, but the user cannot create an event. The user can manage JEM but does not have the required event or category create permission. Review JEM component and category permissions. Do not use the quick icon visibility as proof of create permission.
The main icon is visible, but no secondary add action is shown. The active Joomla administrator module or template does not render the supplied linkadd property. Open JEM through the main icon and use the JEM Events toolbar to create the event.
Installation is rejected. The Joomla version is older than 5.4 or is Joomla 7 or later. Install the plugin only on a currently supported Joomla version.
A plugin class or namespace error is displayed. The plugin files are incomplete, or its service provider was not installed correctly. Reinstall the matching JEM package and verify services/provider.php and src/Extension/Jem.php.

JEM 5.1.0 Beta 4 Appendix

JEM 5.1.0 Beta 4 does not introduce new user-configurable options or different Quick Icon behaviour. The plugin uses the same dashboard context, URLs, icon and core.manage visibility check as JEM 5.0.1 and JEM 5.0.2 Beta 1.

The plugin manifest has been updated with the JEM 5.1.0 Beta 4 package version and creation date.

Source Code and Development References

Related GitHub Issues

ReferenceSubject
#1821 Namespaced Quick Icon plugin class could not be found.
#1766 Historical Quick Icon plugin runtime stability problem.
#1606 Expected Quick Icon plugin behaviour.
#1617 Historical administrator language class compatibility problem.
#1544 Explanation of the Quick Icon plugin's purpose.