Core Enhancement 1 - Place Module in Menu

[YatharthVyas]

The purpose of this PR is to track all the file changes and commits made. Mentors can review the changes and provide feedback.
I will update the description as and when I push more commits.

Plan Document: https://docs.google.com/document/d/1Pl8JGa2hkYkmJzQOn9_mS8a4imDmqc2a/edit#heading=h.gewhdn9rqyeh

---

Testing Instructions

• Run npm ci because this PR involves re-building of assets
• Either run the SQL update script or download and install https://drive.google.com/file/d/1R4962C-MFFS236UW0cTBPn48DucG0-Qr/view?usp=sharing for the Add Module Button Plugin
• Test the frontend and backend placement flow which is summarized here

---

Pull Request for

• Rendering Add Module Button in Frontend via Plugin
• Setting up ?pm=1 and rendering buttons and positions for it
• Passing data of position and menu assignment (pages) from the button to Add Module page
• Adding Preview link in backend’s add/edit module page
• Setting up the Modal for Backend
• Setting up the frontend view for the Modal and returning the data

---

Todo

• Add a message to inform users that they need to login and they need permissions for ?pm=1 view

---

Result After PR

Overall Flow (Latest)

https://drive.google.com/file/d/1xaiEEZfUkE_6p7jCZLss9udkjJiJKJnS/view?usp=sharing

Frontend Flow

Frontend.Placements.mp4

Backend Flow

---

Summary of Changes

1. Switcher Added in Global Configuration for Templates
2. Added the code in SQL Installation Script to set the default value of this Parameter upon the first installation
3. Add Module Button is displayed in <main> in Frontend when the above switcher is saved as 1 or True

---

4. Set up the view for ?pm=1 in Frontend (Here pm stands for Place(ing) Module)
5. The button in (3) is linked to this view
6. The preview shows the Add Module Here button for every position

7. The Add Module Button Works for Every Menu Page (not just index.php):

8. The Add Module Here Button is accessible as it also dictates the position:

---

9. Check for Permissions before displaying Place Modules Buttons for displaying the Add Modules Button and accessing the `?pm=1` view

---

10. Work in Progress on a Controller to set Position by passing data from the button. It displays Menu ID, template ID and name of the position.

11. Template ID in (10) is not required (I checked the databases and Models of Module's Add Methods) so it has been removed.

---

12. Rephrased Add Module Here button to Place Module Here to avoid confusion and generalize it for the Backend Preview Modal that we plan to implement.

13. Removed the HTML tags from language constants

---

14. Position is now pre-filled based on Frontend Placement Selection

---

15. Menu Position is now pre-selected
16. Made a few semantic changes

---

Potential Issues

1. There is a flaw in the get active menu item API for a multilingual website:

https://docs.joomla.org/Menu_and_Menuitems_API_Guide#Active_Menuitem

[YatharthVyas]

I apologize for the review requests. It happened unintentionally. Sorry to disturb all of you.

[bembelimen]

Not your fault, happens automatically as it's in the settings.

[YatharthVyas]

The latest commit fixes Issue #6 but it's not perfect, there is still an extra toolbar at the top (For Frontend only, Backend is fine).
This could be removed by adding &tmpl=component to the URL but it causes an Issue that is, if the user isn't logged in to the backend while opening the modal then it redirects the user to the Admin Dashboard Home page after logging in. (Correct Behavior would be to redirect to the modal view but tmpl=component somehow overrides it)

[YatharthVyas]

The recent set of commits fix #5
And introduces a minor improvement in the Module Position View that no longer displays the card style:

[brianteeman]

This really must be generic so that it will work with all templates and not require any changes to the template itself

[YatharthVyas]

This really must be generic so that it will work with all templates and not require any changes to the template itself

Agreed.
So as of now, the only template (Cassiopeia) specific files that are modified by this PR are:

• Index.php: A condition has been added to display all positions even if the count of Modules for that position is Zero. This condition is only for the ?pm=1 (place module in position) view (Comment)
• New SCSS File in Cassiopeia: The styling of the "Add Module to this Menu" button is a part of Cassiopeia's CSS because the border color of this button depends on the template's primary color var (Comment)

Everything else is general and should work smoothly for all templates.

[brianteeman]

Index.php: A condition has been added to display all positions even if the count of Modules for that position is Zero.

That still makes this core feature dependent on the template :(

[YatharthVyas]

I thought about the template file dependency a lot but I still cannot think of any other way to do it that would be correct.

The changes in this file is more like an improvement. If any 3PD does not do the changes then this feature will still work, the only difference will be that it will only show the active positions that have a module count >= 1

It's not perfect but I hope this is fine :(