Project Repo PR: joomla-projects/gsoc21_core-enhancements#10

Summary of Changes

Access

• The corresponding access.xml actions have been added.

Articles Model

• The getListQuery() method joins the old query with workflow_associations to also consider the workflow stages that belong to com_content.articles only.

SQL Changes:

• The following have been added to the Database Tables:
  • 1 new workflow: COM_WORKFLOW_BASIC_WORKFLOW_MODULES
  • 1 new stage: COM_WORKFLOW_BASIC_STAGE
  • 3 new transitions: Publish, Unpublish, and Trash
• Workflow Associations have been created for all existing modules via an update script / a query during Installation.

Introduce a new Backend Menu Item

• A new menu item for Modules: Workflows to execute CRUD for com_modules

Option to Enable Workflow Integration

• This can be toggled from Global Configuration

Searchtools Filtering

• Option to filter modules via their stage

ModulesComponent.php

• Added necessary functions that are used by Workflow Plugins (Workflows, Featuring and Publishing)

Module Model

• The get query now takes into account the workflow stage associated with each module.
• Added Workflow before and after Save events
• Added a function to get the initial stage for a module (default workflow and default stage)
• Added a query to create workflow association while duplicating modules
• Added a function that prepares the workflow field

Modules Model

• Join the query with workflow associations
• Add a filterForm function to filter based on workflow stage

Modules Template:

• Added workflows column to the table
• This column is conditionally rendered when workflows are enabled
• Added workflows field to default batch body

The Flow:

1. When creating new modules you have to select a workflow and when you save, the default stage under this workflow_id is set as the initial stage of the module.
2. When editing exiting modules, the workflow transition field is shown instead of the workflow_id field, which works similarly to com_content.

New Modules: Select Workflow

(Permanent similar to workflow assignment for com_content)

Edit Existing Modules: Transition Field

Testing Instructions

After a fresh install:
1, Go to Modules (Site or Admin) -> Options -> Integrations -> Enable Workflows
2. Test the transitions in modules view
3. Test CRUD for workflows, stages, and transitions in Modules: Workflows
4. Test Batch and Duplicate

Expected result AFTER applying this Pull Request

Workflows are integrated into Modules and work as expected.

Documentation Changes Required

Possibly yes. Something on the lines of https://docs.joomla.org/Publishing_Workflow_Implementation#Implement_com_workflow_into_your_extension

Mentors

@chmst @nibra @bembelimen
(And special thanks to @richard67)