[Adminhtml] add Events to Widget Grid

[Hanmac]

Description (*)

This adds some Events to the Adminhtml/Widget/Grid,
allowing it to add more Columns without the need to extend the Grid classes.

Example:

• you can add a Join to another table in the set_collection Event
• and then add Columns in the prepare_columns_after Event

Related Pull Requests

• see OpenMage/magento-lts#<issue_number>

Fixed Issues (if relevant)

• fixes OpenMage/magento-lts#<issue_number>

Manual testing scenarios (*)

1. ...
2. ...

Questions or comments

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All automated tests passed successfully (all builds are green)

[sreichel]

How about using $_eventPrefix to access specific grids?

For _afterLoadCollection and _prepareColums we have to change some code to call parent method (instead of return $this).

[Hanmac]

@sreichel Block doesn't have $_eventPrefix (yet)
it is only defined for Core_Model_Abstract

[Hanmac]

@sreichel would it make sense to use Block#getId for Event Names?

Like this?

Mage::dispatchEvent('grid_prepare_columns_after_' . $this->getId(), ['grid' => $this]);

[Copilot]

Pull request overview

This pull request aims to add events to the Adminhtml Widget Grid to allow modifications without extending grid classes. The PR adds two pairs of events (prepare_collection_after and prepare_columns_after/before) and updates several grid child classes to properly call their parent methods.

Changes:

• Added grid lifecycle events (prepare_collection_after, prepare_columns_before/after)
• Fixed grid child classes to properly call parent methods instead of returning $this directly

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
app/code/core/Mage/Adminhtml/Block/Widget/Grid.php	Added event dispatching in grid lifecycle methods
app/code/core/Mage/Index/Block/Adminhtml/Process/Grid.php	Changed to call parent::_afterLoadCollection()
app/code/core/Mage/Adminhtml/Block/Urlrewrite/Product/Grid.php	Changed to call parent::_prepareColumns() via fully qualified name
app/code/core/Mage/Adminhtml/Block/System/Email/Template/Grid.php	Changed to call parent::_prepareColumns()
app/code/core/Mage/Adminhtml/Block/Review/Product/Grid.php	Changed to call parent::_prepareColumns() via fully qualified name
app/code/core/Mage/Adminhtml/Block/Newsletter/Template/Grid.php	Changed to call parent::_prepareColumns()
app/code/core/Mage/Adminhtml/Block/Catalog/Product/Attribute/Set/Grid.php	Changed to call parent::_prepareColumns()
app/code/core/Mage/Adminhtml/Block/Cache/Grid.php	Changed to call parent::_afterLoadCollection()

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sreichel]

@sreichel Block doesn't have $_eventPrefix (yet) it is only defined for Core_Model_Abstract

i know, but we can add it. :)

how about ... getId() would work, but i'd prefer unified naming pattern. 🤓

            Mage::dispatchEvent('adminhtml_widget_grid_prepare_collection_before', [
                'collection' => $collection,
            ]);

            if ($this->_eventPrefix !== '') {
                Mage::dispatchEvent($this->_eventPrefix . '_prepare_collection_before', [
                    'collection' => $collection,
                ]);
            }

[sreichel]

@sreichel would it make sense to use Block#getId for Event Names?

@Hanmac imho ... as for models the eventname should follow classnaming. (and getId() could be same for differnt grids)

Added "some" eventprefixes to grids ... please revert if its not okay.

[sonarqubecloud]

Quality Gate failed

Failed conditions
24.0% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud