[New Feature] Implementing filtering admin modules per admin languages (including custom menu modules) #17215

infograf768 · 2017-07-23T18:46:50Z

Pull Request for Issue #17155

Summary of Changes

Allow administrator menu modules to be tagged and displayed per available administrator languages.
Added Warning when no menu modules are tagged to All languages and some administrator menu modules are missing for an administrator language in order to not suddenly lose all admin menu modules when switching backend language.
This warning will only display when the new Menus parameter option is set to yes.
Added a new adminfilter file for modules.

Testing Instructions

Patch staging.
Set the new parameter in Menus Options.

I have created 3 custom admin menus. French, English and one for ALL

I have assigned each of these menus to an admin menu module and tagged that module to an administrator language.

Tagging to a language is only possible for admin menu modules.

If there are no Published menu module tagged to ALL languages and some menu modules tagged to an administrator language are missing, we get a warning.
On my site I have 6 administrator languages and only 2 have a custom admin menu (French and English).

In the modules manager page

and also in the menus/menu items manager pages

As formerly, if any of the custom admin menus has a compulsory item missing , we get the Warning.
Both Warnings may be combined.

If the Menus Options Filtering parameter is set to No, the language field and columns are not displayed in the modules manager.

Notes

To be sure I get the Warning, I added the code to both menus and modules controller display() method. A better solution is welcome.

The purpose of this patch is to deal ONLY with administrator menu modules.
It can easily be upgraded to deal with all admin modules by modifying the conditional which is now set as a parameter in com_menus.
If set as a Global parameter, or Modules parameter, or system plugin in the future (or right now) the method JLanguageMultilang::isAdminEnabled() will just have to be modified.

Documentation Changes Required

Complete custom admin menus docs.

@izharaazmi
@RCheesley
All improvements welcome.

brianteeman · 2017-07-23T18:55:19Z

administrator/components/com_modules/views/modules/view.html.php

+					'position'       => JText::_('COM_MODULES_HEADING_POSITION'),
+					'name'           => JText::_('COM_MODULES_HEADING_MODULE'),
+					'a.access'       => JText::_('JGRID_HEADING_ACCESS'),
+					'a.language'       => JText::_('JGRID_HEADING_LANGUAGE'),


brianteeman · 2017-07-23T18:55:28Z

administrator/components/com_modules/views/modules/view.html.php

+					'position'       => JText::_('COM_MODULES_HEADING_POSITION'),
+					'name'           => JText::_('COM_MODULES_HEADING_MODULE'),
+					'a.access'       => JText::_('JGRID_HEADING_ACCESS'),
+					'a.language'       => JText::_('JGRID_HEADING_LANGUAGE'),


brianteeman · 2017-07-23T18:56:07Z

administrator/language/en-GB/en-GB.com_menus.ini

@@ -18,6 +18,9 @@ COM_MENUS_BATCH_OPTIONS="Batch process the selected menu items"
 COM_MENUS_BATCH_TIP="If a menu or parent is selected for move/copy, any actions selected will be applied to the copied or moved menu items. Otherwise, all actions are applied to the selected menu items."
 COM_MENUS_CHANGE_MENUITEM="Select or Change Menu Item"
 COM_MENUS_CONFIGURATION="Menus: Options"
+COM_MENUS_CUSTOM_ADMIN_MENU_LABEL="Custom Administrator Menus"
+COM_MENUS_CUSTOM_ADMIN_LANG_FILTER_DESC="Let's filter custom administrator menus per language assigned to mod_menu modules."


Not sure what you are intending to say here - do you really mean "let us..."

I meant "allows filtering". will change.

Quy · 2017-07-24T02:20:43Z

administrator/language/en-GB/en-GB.com_menus.ini

@@ -18,6 +18,9 @@ COM_MENUS_BATCH_OPTIONS="Batch process the selected menu items"
 COM_MENUS_BATCH_TIP="If a menu or parent is selected for move/copy, any actions selected will be applied to the copied or moved menu items. Otherwise, all actions are applied to the selected menu items."
 COM_MENUS_CHANGE_MENUITEM="Select or Change Menu Item"
 COM_MENUS_CONFIGURATION="Menus: Options"
+COM_MENUS_CUSTOM_ADMIN_MENU_LABEL="Custom Administrator Menus"


Alpha order.

infograf768 · 2017-07-24T06:39:27Z

After some thought, I think we should create the parameter in the Modules Options and not the Menus options. In that case, we may not limit it to mod_menu and make it a totally new feature.

What do you think?

izharaazmi · 2017-07-24T07:12:30Z

administrator/components/com_menus/controller.php

+
+				$totalModules = (int) $db->loadResult();
+
+				if ($totalModules != $adminLanguages)


@infograf768 Installed 3 languages - en, fr, de and having module counts - en = 1, fr = 0, de = 2 will pass this test but its not what we want. Is that correct?

If you do not have any custom admin menu with module set to ALL, then we should change this conditional to
if ($totalModules < $adminLanguages)
it would solve the issue and display the warning I guess.
Can you confirm?

@izharaazmi
Can you confirm?

Hmm, no. This is indeed not enough
We need to improve this by fetching each admin language and make sure we have at least one module assigned to each.
Let's work on that.

I think group by and IN (<language list>) should solve the issue.

@izharaazmi
Without taking these out of the controllers for now, can you propose here a full snippet to replace the existing one? I am not good a groupby stuff ;)

we have now:

// Check custom administrator menu modules if (JLanguageMultilang::isAdminEnabled()) { // Check if we have any mod_menu module set to All languages $db = JFactory::getDbo(); $query = $db->getQuery(true) ->select('COUNT(*)') ->from($db->qn('#__modules')) ->where($db->qn('module') . ' = ' . $db->quote('mod_menu')) ->where($db->qn('published') . ' = 1') ->where($db->qn('client_id') . ' = 1') ->where($db->qn('language') . ' = ' . $db->quote('*')); $db->setQuery($query); $modulesAll = (int) $db->loadResult(); // If none, check that we have a mod_menu module for each admin language if ($modulesAll == 0) { $adminLanguages = count(JLanguageHelper::getInstalledLanguages(1)); $db = JFactory::getDbo(); $query = $db->getQuery(true) ->select('COUNT(*)') ->from($db->qn('#__modules')) ->where($db->qn('module') . ' = ' . $db->quote('mod_menu')) ->where($db->qn('published') . ' = 1') ->where($db->qn('client_id') . ' = 1') ->where($db->qn('language') . ' != ' . $db->quote('*')); $db->setQuery($query); $totalModules = (int) $db->loadResult(); if ($totalModules != $adminLanguages) { $msg = JText::_('JMENU_MULTILANG_WARNING'); JFactory::getApplication()->enqueueMessage($msg, 'warning'); } } }

izharaazmi · 2017-07-24T07:22:41Z

administrator/components/com_modules/models/module.php

@@ -541,6 +541,15 @@ public function getForm($data = array(), $loadData = true)
 		if ($clientId == 1)
 		{
 			$form = $this->loadForm('com_modules.module.admin', 'moduleadmin', array('control' => 'jform', 'load_data' => $loadData), true);
+
+			// Display language field to filter admin custom menus per language
+			if ($module == 'mod_menu' && JLanguageMultilang::isAdminEnabled())


Can we allow language filtering for all modules both client? I thing you have done all the work already and we can quickly expand the scope here.

This was my question above:
#17215 (comment)

Oh right. That would be a great thing.

izharaazmi · 2017-07-24T07:24:38Z

administrator/components/com_modules/views/modules/tmpl/default.php

+								<?php elseif ($item->language == '*'):?>
+									<?php echo JText::alt('JALL', 'language'); ?>
+								<?php else:?>
+									<?php echo $this->escape($item->language); ?>


IIIRC, we are displaying language flags somewhere.

We should NOT display language flags because this is independant of the Content Languages and can be used on monolanguage sites where Content Languages are not necessary.
The language field is fetching administrator languages NOT content languages.

izharaazmi · 2017-07-24T07:30:21Z

administrator/components/com_modules/controller.php

@@ -76,6 +76,47 @@ public function display($cachable = false, $urlparams = false)
 		// Load the submenu.
 		ModulesHelper::addSubmenu($this->input->get('view', 'modules'));

+		// Check custom administrator menu modules
+		if (JLanguageMultilang::isAdminEnabled())


I think its not good, not enough to test this condition in module manager and menu manager alone. This check should be something that occurs always. Would it be any good if we do this in postinstall messages?

Postinstall messages may show only once and then dismissed.
The ideal solution would be in the index.php of the admin template or, better, when we load the template if we want to the proper check all the time.

izharaazmi · 2017-07-24T08:38:04Z

@infograf768 This should work for the check part.

if (JLanguageMultilang::isAdminEnabled())
{
	$languages = JLanguageHelper::getInstalledLanguages(1, true);
	$langCodes = array();

	foreach ($languages as $language)
	{
		$langCodes[$language->metadata['tag']] = $language->name;
	}

	$db    = JFactory::getDbo();
	$query = $db->getQuery(true);

	$query->select($db->qn('m.language'))
		->from($db->qn('#__modules', 'm'))
		->where($db->qn('m.module') . ' = ' . $db->quote('mod_menu'))
		->where($db->qn('m.published') . ' = 1')
		->where($db->qn('m.client_id') . ' = 1')
		->group($db->qn('m.language'));

	$mLanguages = $db->setQuery($query)->loadColumn();

	// Check if we have a mod_menu module set to All languages or a mod_menu module for each admin language.
	if (!in_array('*', $mLanguages) && count($langMissing = array_diff(array_keys($langCodes), $mLanguages)))
	{
		$app         = JFactory::getApplication();
		$langMissing = array_intersect_key($langCodes, array_flip($langMissing));

		$app->enqueueMessage(JText::sprintf('JMENU_MULTILANG_WARNING_MISSING_MODULES', implode(', ', $langMissing)), 'warning');
	}
}

JMENU_MULTILANG_WARNING_MISSING_MODULES="The administrator menu module for <strong>%s</strong> does not exist. Create a custom administrator menu and module for each administrator language or publish a menu module set to All languages."

infograf768 · 2017-07-24T09:41:03Z

@izharaazmi
Thanks. Committed after just changing name to nativeName.
This gives:

infograf768 · 2017-07-24T09:45:50Z

@mbabker @Bakual

Shall we set the parameter in the Modules Options instead of Menus Options?
In that case, shall we implement language filtering for all admin modules instead of only mod_menu?

brianteeman · 2017-07-24T09:50:54Z

Language filtering for admin modules would be good. This has come up before as a feature request

brianteeman · 2017-07-24T14:48:23Z

Just wondering if we even need an option. Would I r not be enough to check if the admin menu exists for the selected admin language

RCheesley · 2017-07-24T14:55:44Z

I'd say it would be the next logical step to be able to deliver different language versions of any module on the administrator interface if we can get the menu modules working, so if both can be accomplished at the same time it would be great!

…

On 24 July 2017 at 15:48, Brian Teeman ***@***.***> wrote: Just wondering if we even need an option. Would I r not be enough to check if the admin menu exists for the selected admin language — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#17215 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACy3oaSON0vyZ6Q8HBsP_jh8CG8mwpY7ks5sRK7CgaJpZM4OgiMn> .

-- Be like me, be Carbon free - don't print this and save a tree IMPORTANT: The contents of this email and any attachments are confidential. They are intended for the named recipient(s) only. If you have received this email by mistake, please notify the sender immediately and do not disclose the contents to anyone or make copies thereof.

infograf768 · 2017-07-24T16:38:15Z

I will modify the PR to get the multilingual option for all modules.
Tomorrow or after tomorrow. Target 3.8 anyway . 😄

Option is set such.

izharaazmi · 2017-07-27T14:54:45Z

@infograf768 I'd rather try getting this into 3.8 first, and we can discuss these later 😄 👍

izharaazmi · 2017-07-27T15:08:42Z

@infograf768 My tests are ok, just added few comments please reply to them.

infograf768 · 2017-07-27T15:59:15Z

@izharaazmi

the new method may find a use (once modified) for other stuff than modules.

Correct. Therefore this check should not be bound to com_modules params anyway, I guess?

"Should not be bound ONLY to..." .
This is why I wrote above "once modified":

I may have though that the new method may find a use (once modified) for other stuff than modules.

The code for example for specific enabled plugins or user groups or whatever would be "added" to the one checking the admin modules params.

if "something" || "somethingelse" || "anothercondition" || "the modules params"
{
     $enabled = true;
}

if judged necessary, we may then add a new method in JModuleHelper and use it in JLanguageMultilang::isAdminEnabled() to keep things in a handy place.

We could do that right now, but we are in a hurry to get this in 3.8.0
😃

If this is satisfying, please add test in issues.joomla.org

izharaazmi · 2017-07-27T16:02:48Z

I mean my comments at:

infograf768 · 2017-07-27T16:05:21Z

did not get these, weird.
Looking

since version

infograf768 · 2017-07-27T16:14:35Z

Done, if I understood correctly

izharaazmi · 2017-07-27T16:26:47Z

I have tested this item ✅ successfully on 31abf2d

Filters working for backend modules and new configuration parameter enables/disables filtering feature correctly.

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/17215.}

izharaazmi · 2017-07-27T16:27:33Z

I guess this counts as 2 tests as the changes were not affecting code. Right?

izharaazmi · 2017-07-27T09:33:32Z

libraries/src/Joomla/CMS/Language/Multilanguage.php

+	 *
+	 * @since   3.8.0
+	 */
+	public static function isAdminEnabled()


I think this method does not fit here. This check is specific to modules so this should be not in global CMS\Language\Multilanguage context.

already replied

izharaazmi · 2017-07-27T15:06:52Z

libraries/cms/html/adminlanguage.php

+	 *
+	 * @return  string
+	 *
+	 * @see     JFormFieldAdminLanguage


Could not find JFormFieldAdminLanguage. Also could not find any usage of this.

i already deleted that. was copy paste

izharaazmi · 2017-07-27T15:07:35Z

libraries/cms/html/adminlanguage.php

+/**
+ * Utility class working with administrator language select lists
+ *
+ * @since  1.6


You are adding this class in this PR?

yes, we need a correct batch language method for admin modules, i.e. dealing with administrator languages and not content languages.

izharaazmi · 2017-07-27T17:57:16Z

Is this RTC?

ghost · 2017-07-27T18:20:31Z

RTC after two successful tests.

wojsmol · 2017-07-27T20:50:42Z

@infograf768 I see RTC but if enything is neadet plese ping me.

infograf768 · 2017-07-28T06:34:03Z

@izharaazmi @mbabker

After a good night sleep, I think @izharaazmi was right. 😃
If an admin language filtering may be necessary in the future for other stuff than the modules, we better move the conditional method into JModuleHelper.

This would mean adding a similar method for each element concerned in back-end with the possibility to enable or not such admin lang filtering by checking a specific parameter.

Admins will then be able to choose, element by element, what they want to be filtered or not.

Now that this PR is merged, it is quite easy to make a new PR changing that aspect of it.
It is not as urgent as the new feature.
Would you like me to prepare that now?

izharaazmi · 2017-07-28T06:40:44Z

I have a patch from last evening ready! :)

infograf768 · 2017-07-28T06:41:29Z

LOL
Let's wait for @mbabker feedback

mbabker · 2017-07-28T11:13:28Z

You guys will use this more often than me, so whatever makes sense to you roll with it.

infograf768 · 2017-07-28T11:58:27Z

@izharaazmi
you do or i do?

izharaazmi · 2017-07-28T12:16:41Z

@infograf768 I already did the patch which was aimed against your branch last evening. I can do that against staging now.

izharaazmi · 2017-07-28T12:26:00Z

See #17314

infograf768 added 2 commits July 23, 2017 19:43

Implementing multilingual custom backend menus

7ce7d64

Implementing multilingual custom backend menus

9141551

joomla-cms-bot added Language Change This is for Translators PR-staging labels Jul 23, 2017

infograf768 requested review from mbabker and Bakual July 23, 2017 18:47

infograf768 mentioned this pull request Jul 23, 2017

Add ability to create multilingual associations for custom administrator menus #17155

Closed

brianteeman reviewed Jul 23, 2017

View reviewed changes

Quy reviewed Jul 24, 2017

View reviewed changes

infograf768 added 2 commits July 24, 2017 08:31

Alignment

85205a8

Correcting grammar and alpha order

91e2e74

izharaazmi reviewed Jul 24, 2017

View reviewed changes

Improving Warning. Thanks @izharaazmi

1af85b3

mbabker added this to the Joomla 3.8.0 milestone Jul 24, 2017

mbabker added the Feature label Jul 24, 2017

mbabker added this to Testing/Review in [3.8] General Jul 24, 2017

Modifyimg patch to allow language filtering per module when modules

58aa2fe

Option is set such.

infograf768 added 2 commits July 27, 2017 18:08

Update adminlanguage.php

664f5b8

since version

Update adminlanguage.php

31abf2d

izharaazmi approved these changes Jul 27, 2017

View reviewed changes

joomla-cms-bot removed this from the Joomla 3.8.0 milestone Jul 27, 2017

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Jul 27, 2017

mbabker added this to the Joomla 3.8.0 milestone Jul 27, 2017

mbabker merged commit 1bcfb4a into joomla:staging Jul 27, 2017

joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Jul 27, 2017

mbabker moved this from Testing/Review to Completed in [3.8] General Jul 27, 2017

infograf768 deleted the multilang_custom_adminmenus branch July 28, 2017 06:23

izharaazmi mentioned this pull request Jul 28, 2017

Moved JLanguageMultilang::isAdminEnabled() to JModuleHelper::isAdminMultilang() #17314

Merged

twister65 mentioned this pull request Aug 22, 2017

New Random Image Module Error #17656

Closed


		$totalModules = (int) $db->loadResult();

		if ($totalModules != $adminLanguages)

[New Feature] Implementing filtering admin modules per admin languages (including custom menu modules) #17215

[New Feature] Implementing filtering admin modules per admin languages (including custom menu modules) #17215

Conversation

infograf768 commented Jul 23, 2017 • edited by joomla-cms-bot

Summary of Changes

Testing Instructions

Notes

Documentation Changes Required

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

infograf768 commented Jul 24, 2017

Choose a reason for hiding this comment

infograf768 Jul 24, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

izharaazmi commented Jul 24, 2017 • edited

infograf768 commented Jul 24, 2017

infograf768 commented Jul 24, 2017

brianteeman commented Jul 24, 2017

brianteeman commented Jul 24, 2017

RCheesley commented Jul 24, 2017 via email

infograf768 commented Jul 24, 2017

izharaazmi commented Jul 27, 2017

izharaazmi commented Jul 27, 2017

infograf768 commented Jul 27, 2017

izharaazmi commented Jul 27, 2017

infograf768 commented Jul 27, 2017

infograf768 commented Jul 27, 2017

izharaazmi commented Jul 27, 2017

izharaazmi commented Jul 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

izharaazmi commented Jul 27, 2017

ghost commented Jul 27, 2017

wojsmol commented Jul 27, 2017

infograf768 commented Jul 28, 2017

izharaazmi commented Jul 28, 2017 via email

infograf768 commented Jul 28, 2017

mbabker commented Jul 28, 2017

infograf768 commented Jul 28, 2017

izharaazmi commented Jul 28, 2017 via email

izharaazmi commented Jul 28, 2017

infograf768 commented Jul 23, 2017 •

edited by joomla-cms-bot

infograf768 Jul 24, 2017 •

edited

izharaazmi commented Jul 24, 2017 •

edited