[New Feature] Multilingual: Propagating existing associations if desired #21321

infograf768 · 2018-07-31T09:37:04Z

Pull Request for Issue #21250

Summary of Changes

This adds a "Propagate" button in the Associations tab when editing a contact, category, article, menu item, newsfeed.
This button will display when an association is selected in a Content Language field, offering the option to Propagate the associations defined for that item to the other Content Languages.

The button will display ONLY when there are more than 2 Content Languages defined for the site.
A message will display with the results obtained.

It is B/C as it will not break anything and one is totally free to choose or not to use the button, thus keeping the possibility to Clear/Select/Create any associations as before.

Using it prevents breaking existing associations when the wrong items are chosen for some fields.

A big thank you to Robbie Jackson for the long work to get this new functionality.
Target Milestone: 3.9.0

Testing Instructions

Create a Multilingual site with 3 or more languages.
Create items in each type: (contact, category, article, menu item, newsfeed) for 2 of these languages and associate them in each case.

Create a new item for each type, select another language than the ones which are already associated.
Save (NOT save and close) this item.
Display the Association tab.

You will see, as usual (here for 4 Content Languages)

I do have already associations set for English and French.

I select for English the item which I know is associated.

The button displays (Better tip welcome)

Clicking on the button will give

Result: the already associated category in French is added in the French field.
As we have no association set for Spanish, the field remains empty.
The message displays (it is the same in all cases except if there is an Ajax error)
All existing associations have been set. If some are missing you may have to select or create them manually.

If we have already associated all fields, clicking on Propagate will just display the message.

If we change an association in one of the fields and click Propagate, it is the associations from that language item that will be propagated and therefore replace the ones existing.

Documentation Changes Required

Yes

infograf768 · 2018-07-31T09:41:00Z

the json files need corrections for cs. Can be tested and commented nevertheless. ;)

brianteeman · 2018-07-31T09:44:27Z

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

+JGLOBAL_ASSOCIATIONS_PROPAGATE_BUTTON="Propagate"
+JGLOBAL_ASSOCIATIONS_PROPAGATE_FAILED="Failed propagating associations. You may have to select or create them manually."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE="All existing associations have been set. If some are missing you may have to select or create them manually."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_TIP="Propagates this selected item existing associations."


Please correct to

"Propagates this item's existing associations."

brianteeman · 2018-07-31T09:46:16Z

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

@@ -281,6 +281,10 @@ JGLOBAL_ARTICLE_ORDER_DESC="The order that articles will show in."
 JGLOBAL_ARTICLE_ORDER_LABEL="Article Order"
 JGLOBAL_ARTICLES="Articles"
 JGLOBAL_ASSOC_NOT_POSSIBLE="To define associations, please make sure the item language is not set to 'All'."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_BUTTON="Propagate"
+JGLOBAL_ASSOCIATIONS_PROPAGATE_FAILED="Failed propagating associations. You may have to select or create them manually."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE="All existing associations have been set. If some are missing you may have to select or create them manually."


How likely is it that an association will be missing? Seems odd to me to have that on a success message.

It will happen when there is no item associated in a specific language. See image above where there is nothing for Spanish

so in that case nothing is missing as it doesnt exist
The first sentence is more than enough

This message is also informing the user that an association for one or more language(s) may be missing. It may be what the user wants but it also may not be.
In that case the user can select an item or create one directly in this interface.
This is important.

thats not the role of a success message.

It is only a success message for what could be propagated.

brianteeman · 2018-07-31T09:46:37Z

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

@@ -281,6 +281,10 @@ JGLOBAL_ARTICLE_ORDER_DESC="The order that articles will show in."
 JGLOBAL_ARTICLE_ORDER_LABEL="Article Order"
 JGLOBAL_ARTICLES="Articles"
 JGLOBAL_ASSOC_NOT_POSSIBLE="To define associations, please make sure the item language is not set to 'All'."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_BUTTON="Propagate"
+JGLOBAL_ASSOCIATIONS_PROPAGATE_FAILED="Failed propagating associations. You may have to select or create them manually."


Shouldn't this be "will" not "may"?

Some one may not want to create associations for a specific language.
Change to ?
If desired, you will have to select or create them manually.

then they havent failed and this isnt a failure message

Propagate has failed (for an unknown reason. It may be the case for a 3rd party component which is badly coded). It does not mean the user lost the possibility to associate items by selecting/creating them.

I am now waiting for tests. Thank you.

ok change to your suggestion of "If desired, you will have to select or create them manually.

brianteeman · 2018-07-31T10:32:30Z

Testing this and my only issue is with the messages

The propagate button says

Propagate this items existing associations

But you always get this message

All existing associations have been set. If some are missing you may have to select or create them manually.

The code should check to see if there any associations to propagate and if not then the message should be

No associations exist to propagate

And if there are associations to propagate then the message should be

All existing associations have been set.

infograf768 · 2018-07-31T14:37:36Z

We will now get 3 types of messages:
JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE_ALL="All existing associations have been set."
JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE_NONE="No associations exist to propagate."
JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE_SOME="Some associations have been set: %s"

JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE_SOME will also display the language(s) where associations have been added.

Example. Here I selected an article for English. It added the French existing association, but as the Spanish one did not exist, it is that message which is used displaying which association was set.

infograf768 · 2018-07-31T14:40:11Z

Restarted drone who failed on js.

brianteeman · 2018-07-31T15:17:07Z

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

+JGLOBAL_ASSOCIATIONS_PROPAGATE_FAILED="Failed propagating associations. You may have to select or create them manually."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE_ALL="All existing associations have been set."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE_NONE="No associations exist to propagate."
+JGLOBAL_ASSOCIATIONS_PROPAGATE_MESSAGE_SOME="Some associations have been set: %s"


Please change to
Associations have been set for: %s

brianteeman · 2018-07-31T15:18:12Z

Much better now.

I am also getting a missing string JGLOBAL_ASSOCIATIONS_PROPAGATE_TIP

infograf768 · 2018-07-31T15:31:17Z

done

jreys · 2018-08-01T03:14:59Z

I have tested this item ✅ successfully on eabc256

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

infograf768 · 2018-08-01T04:19:57Z

One more tester.

Quy · 2018-08-01T04:27:38Z

administrator/components/com_categories/controllers/ajax.json.php

+				$associations[$lang]->title = $categoryTable->title;
+			}
+
+			$message = null;


Remove. Not necessary as it will be assigned later in the if statement.

Waiting for other comments from you before changing. 👍

Repeat this change in the other files.

Quy · 2018-08-01T04:38:51Z

administrator/components/com_newsfeeds/models/fields/modal/newsfeed.php

@@ -169,6 +176,23 @@ function jSelectNewsfeed_" . $this->id . "(id, title, object) {
 				. '</a>';
 		}

+		// Propagate contact button


Update comment.

infograf768 · 2018-08-01T05:59:05Z

@Quy
All done. Thanks.

infograf768 · 2018-08-01T14:11:55Z

@Quy @franz-wohlkoenig @brianteeman
Please add your tests.

ghost · 2018-08-01T14:23:05Z

@infograf768 have read Instructions a few Times but didn't understand really what is to test. So i need Time.

ghost · 2018-08-02T06:25:49Z

I have tested this item ✅ successfully on b902d37

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

ghost · 2018-08-02T06:26:44Z

Ready to Commit after two successful tests.

infograf768 · 2018-08-02T07:52:56Z

@mbabker
I have tagged this to 3.9. Can you merge?

mbabker · 2018-08-02T12:16:01Z

administrator/components/com_categories/views/category/tmpl/edit.php

@@ -101,6 +101,7 @@
 		<?php echo $this->form->getInput('extension'); ?>
 		<input type="hidden" name="task" value="" />
 		<input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>" />
+		<?php echo '<input id="token" type="hidden" name="' . JSession::getFormToken() . '" value="1" />'; ?>


This line shouldn't be necessary, this is exactly what the JHtml call immediately below does.

mbabker · 2018-08-02T12:16:26Z

administrator/components/com_contact/views/contact/tmpl/edit.php

@@ -120,5 +120,6 @@
 	</div>
 	<input type="hidden" name="task" value="" />
 	<input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>" />
+	<?php echo '<input id="token" type="hidden" name="' . JSession::getFormToken() . '" value="1" />'; ?>


Same as above.

mbabker · 2018-08-02T12:16:58Z

administrator/components/com_content/views/article/tmpl/edit.php

@@ -138,6 +138,7 @@
 		<input type="hidden" name="task" value="" />
 		<input type="hidden" name="return" value="<?php echo $input->getCmd('return'); ?>" />
 		<input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>" />
+		<?php echo '<input id="token" type="hidden" name="' . JSession::getFormToken() . '" value="1" />'; ?>


Same as above.

mbabker · 2018-08-02T12:17:15Z

administrator/components/com_menus/views/item/tmpl/edit.php

@@ -232,6 +232,7 @@

 	<input type="hidden" name="task" value="" />
 	<input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>" />
+	<?php echo '<input id="token" type="hidden" name="' . JSession::getFormToken() . '" value="1" />'; ?>


Same as above.

mbabker · 2018-08-02T12:17:28Z

administrator/components/com_newsfeeds/views/newsfeed/tmpl/edit.php

@@ -107,5 +107,6 @@
 	</div>
 	<input type="hidden" name="task" value="" />
 	<input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>" />
+	<?php echo '<input id="token" type="hidden" name="' . JSession::getFormToken() . '" value="1" />'; ?>


Same as above.

mbabker · 2018-08-02T12:20:01Z

media/system/js/associations-edit-uncompressed.js

+		var currentLang = jQuery('#jform_language').find(":selected").val();
+
+		// Find the token so that it can be sent in the Ajax request as well
+		var token = jQuery("#token").attr("name");


Instead of finding the token in this way, the API added in #14952 should be used instead.

You mean using
var token = jQuery('meta[name=csrf-token]').val(); instead?

hmm, that does not work

In the layouts, you have to add a JHtml::_('jquery.token'); call, then you don't even need to find the token and manually include it when using jQuery.ajax because that PHP call will set up jQuery to include the token automatically.

This works.
var token = Joomla.getOptions('csrf.token', '');

Is that OK, @mbabker ?

I did not add the <?php echo JHtml::_('jquery.token'); ?>
Just deleted the extraneous lines in the edit.php and used
var token = Joomla.getOptions('csrf.token', '');

As I did not know what would be the consequences

Can we go with that?

infograf768 · 2018-08-02T13:21:31Z

@mbabker
Do we need new tests?

dgrammatiko · 2018-08-02T14:36:05Z

media/system/js/associations-edit-uncompressed.js

+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	window.injectAssociations = function(result, callbackFunctionPrefix) 


This is really bad. Please name this as Joomla.injectAssociations. Global variables, functions etc are as bad in Javascipt as they are in PHP 👎

I guess Robbie used this as we have above existing
window.hideAssociation
and
window.showAssociationMessage

I guess I found what has to be modifed to fit as both the functions use window.
It is not the purpose of this patch to also correct the existing ones.

@dgrammatiko
Do you agree with my statement?
If yes, I will do the patch right now

infograf768 · 2018-08-03T08:06:19Z

@dgrammatiko
Modified the new js functions name as required.
We can't obviously normalize the others as it would not be B/C.

@franz-wohlkoenig @jreys
Please test again. :)

ghost · 2018-08-04T10:12:25Z

I have tested this item ✅ successfully on 888a280

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

infograf768 · 2018-08-04T14:18:13Z

@mbabker Can you now merge?

infograf768 · 2018-08-04T15:33:04Z

@mbabker
As it is a new feature, shall not it be merged in 3.9.0 ?

mbabker · 2018-08-04T15:33:33Z

💩

… if desired (#21321)" This reverts commit 8bacca9.

… if desired (#21321)" (#21408) This reverts commit 8bacca9.

mbabker · 2018-08-04T15:40:41Z

Branch merged to 3.9-dev via 11153f7

infograf768 · 2018-08-04T15:40:58Z

Thanks.

[New Feature] Multilingual: Propagating existing associations if desired

ffc424c

infograf768 requested a review from brianteeman as a code owner July 31, 2018 09:37

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

infograf768 mentioned this pull request Jul 31, 2018

Adding association to an item doe not add the association to the already associated items #21250

Closed

brianteeman reviewed Jul 31, 2018

View reviewed changes

infograf768 added 2 commits July 31, 2018 11:47

cs

df482b4

lang change

96bed1b

Change and add new messages

6970292

brianteeman reviewed Jul 31, 2018

View reviewed changes

lang changes

eabc256

Quy reviewed Aug 1, 2018

View reviewed changes

Small corrections without effect on resulting funtionnality

b902d37

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Aug 2, 2018

mbabker reviewed Aug 2, 2018

View reviewed changes

using new API for token

ca844f1

dgrammatiko suggested changes Aug 2, 2018

View reviewed changes

modifying js function to use Joomla. instead of window.

888a280

joomla-cms-bot removed this from the Joomla 3.9.0 milestone Aug 4, 2018

joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Aug 4, 2018

infograf768 added this to the Joomla 3.9.0 milestone Aug 4, 2018

mbabker merged commit 8bacca9 into joomla:staging Aug 4, 2018

mbabker added a commit that referenced this pull request Aug 4, 2018

Revert "[New Feature] Multilingual: Propagating existing associations…

9e1a859

… if desired (#21321)" This reverts commit 8bacca9.

mbabker added a commit that referenced this pull request Aug 4, 2018

Revert "[New Feature] Multilingual: Propagating existing associations…

e311a04

… if desired (#21321)" (#21408) This reverts commit 8bacca9.

infograf768 deleted the assoc_propagate branch August 4, 2018 15:41

zero-24 mentioned this pull request Aug 29, 2018

[3.9] [New Feature] Multilingual: Propagating existing associations if desired joomlagerman/joomla#449

Closed

wilsonge mentioned this pull request May 24, 2019

[4.0] Remove jquery from modals field #25002

Merged

ghost mentioned this pull request Jun 29, 2019

[4.0] Multilingual Propagate method broken #25364

Closed

shoulders mentioned this pull request Oct 13, 2020

RJS: fix joomla associations being lost - add a propagate button shoulders/com_qwhelloworld-j3#52

Open

Fedik mentioned this pull request Apr 30, 2023

[5.0] Generic ModalSelect field #40462

Draft

4 tasks

[New Feature] Multilingual: Propagating existing associations if desired #21321

[New Feature] Multilingual: Propagating existing associations if desired #21321

Conversation

infograf768 commented Jul 31, 2018 • edited by joomla-cms-bot

Summary of Changes

Testing Instructions

Documentation Changes Required

infograf768 commented Jul 31, 2018

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 Jul 31, 2018 • 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

infograf768 Jul 31, 2018 • 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

brianteeman commented Jul 31, 2018 • edited

infograf768 commented Jul 31, 2018 • edited

infograf768 commented Jul 31, 2018

Choose a reason for hiding this comment

brianteeman commented Jul 31, 2018

infograf768 commented Jul 31, 2018

jreys commented Aug 1, 2018

infograf768 commented Aug 1, 2018

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 Aug 1, 2018

infograf768 commented Aug 1, 2018

ghost commented Aug 1, 2018

ghost commented Aug 2, 2018

ghost commented Aug 2, 2018

infograf768 commented Aug 2, 2018

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

infograf768 Aug 2, 2018 • edited

Choose a reason for hiding this comment

infograf768 commented Aug 2, 2018

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 Aug 3, 2018

ghost commented Aug 4, 2018

infograf768 commented Aug 4, 2018

infograf768 commented Aug 4, 2018

mbabker commented Aug 4, 2018

mbabker commented Aug 4, 2018

infograf768 commented Aug 4, 2018

infograf768 commented Jul 31, 2018 •

edited by joomla-cms-bot

infograf768 Jul 31, 2018 •

edited

infograf768 Jul 31, 2018 •

edited

brianteeman commented Jul 31, 2018 •

edited

infograf768 commented Jul 31, 2018 •

edited

infograf768 Aug 2, 2018 •

edited