Update typeReferenceBlock definition #18933

leandrommedeiros · 2018-10-29T19:55:54Z

Description (*)

Including the "class" attribute to the typeReferenceBlock definition allows you to update a the class attribute of a block tag when overriding or updating a layout XML file without the need to remove the original block and re-add it with the same name but different class and without using a preference in the Dependency Injector.

Manual testing scenarios (*)

Simple scenario:

On your custom module, create a layout file
Add the tag update with the handle to the any other layout you wish to use as basis.
Add a referenceBlock tag to any block found in the original layout, using the same name as the original but with a new value for the class attribute.
Create your own block class in the Vendor/Module/Block directory and voilá, you are now able to have your own module, with a layout based on any other module, with a new block behavior and, since you didn't use any preference, the original module still works the same.

Scenario I applied:

My wish was to create my own Admin Report using the Magento's Report New Accounts as a basis, but without the "Period" dropdown in the toolbar, so here's what I did:

On my module MyVendor_CustomReports I've created the file view/adminhtml/layout/report_customer_vip_grid.xml with the following content:

<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <update handle="reports_report_grid"/>
    <body>
        <referenceBlock name="adminhtml.report.grid" class="MyVendor\CustomReports\Block\Adminhtml\Grid">
            ...
        </referenceBlock>
    </body>
</page>

I created the new Block class MyVendor\CustomReports\Block\Adminhtml\Grid extending the \Magento\Reports\Block\Adminhtml\Grid class.
I overrided the value of the attribute $_template to MyVendor_CustomReports::grid.phtml.
I copied Magento/Reports/view/templates/grid.phtml to MyVendor/CustomReports/view/templates/grid.phtml and edited it to erase the select element.

This worked as fine as any other fallback, but it was only possible editing the elements.xsd file (this PR), otherwise you get a "invalid attribute 'class'" exception.

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds on Travis CI are green)

Including the "class" attribute to the typeReferenceBlock definition allows you to update a block class when overriding or updating a layout.xml file without the need to remove the original block and re-add it with the same name but different class.

magento-cicd2 · 2018-10-29T19:55:56Z

All committers have signed the CLA.

magento-engcom-team · 2018-10-29T19:56:07Z

Hi @leandrommedeiros. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento-engcom-team give me test instance - deploy test instance based on PR changes
@magento-engcom-team give me $VERSION instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Assistant documentation

orlangur · 2018-10-29T22:29:46Z

@leandrommedeiros nice catch! This is exactly what we needed in scope of #11709 (comment) already.

@antonkril @buskamuza could you please clarify if there was some reasoning behind disallowing class change via referenceBlock?

buskamuza · 2018-10-30T03:17:26Z

I don't remember a specific reason.
One thing I can think about is that it's possible to specify a class from a different hierarchy, so any other customization (a template) may be broken because new block doesn't provide the same set of methods. This can be covered with a test.
It would be really helpful if you could submit a proposal to https://github.com/magento/architecture to make sure we don't miss anything with this change.

sivaschenko · 2018-11-12T11:40:45Z

Hi @leandrommedeiros could you please submit a proposal as a PR to https://github.com/magento/architecture to be approved by architects. cc @orlangur

orlangur · 2018-11-12T13:27:01Z

@sivaschenko I'm supposed to do it actually including discussion already performed in #app-design Slack channel.

sidolov · 2018-11-28T21:16:21Z

Hi @leandrommedeiros , I am closing this PR now due to inactivity.
Please reopen and update if you wish to continue.
Thank you for the collaboration!

sivaschenko · 2019-01-10T13:29:12Z

Reopening the PR as it is a dependency for #11709 . A proposal was submitted to Architectural Discussions that is scheduled 23rd January 2019: magento/architecture#59 (comment)

sivaschenko · 2019-01-15T18:25:37Z

@orlangur @leandrommedeiros please consider attending the public architecture meetup 23rd January to discuss this change.

orlangur

@buskamuza @sivaschenko I'm not sure what's the process is but from magento/architecture#85 this architectural change seems to be approved.

magento-engcom-team · 2019-03-24T16:29:35Z

Hi @orlangur, thank you for the review.
ENGCOM-4563 has been created to process this Pull Request

magento-engcom-team · 2019-03-24T16:29:36Z

@leandrommedeiros thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

soleksii · 2019-04-02T13:27:43Z

✔️ QA Passed

Before:

After:

m2-assistant · 2019-04-08T11:38:42Z

Hi @leandrommedeiros, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Update ReferenceBlock Class

ea89448

Including the "class" attribute to the typeReferenceBlock definition allows you to update a block class when overriding or updating a layout.xml file without the need to remove the original block and re-add it with the same name but different class.

magento-engcom-team added Component: Framework/View Release Line: 2.3 labels Oct 29, 2018

orlangur self-assigned this Oct 29, 2018

sivaschenko mentioned this pull request Nov 6, 2018

#7065 Allow page.main.title block to decide if title should be translated #11709

Closed

4 tasks

sivaschenko added the Progress: needs update label Nov 12, 2018

sidolov closed this Nov 28, 2018

sivaschenko mentioned this pull request Jan 10, 2019

January 23, 2019 magento/architecture#59

Closed

sivaschenko reopened this Jan 10, 2019

sivaschenko removed the Progress: needs update label Jan 10, 2019

sivaschenko self-assigned this Jan 10, 2019

This was referenced Feb 6, 2019

Proposal: Allow class attribute for referenceBlock type in layout xml magento/architecture#85

Merged

February 6th, 2019 magento/architecture#75

Closed

February 20th, 2019 magento/architecture#76

Closed

orlangur approved these changes Mar 24, 2019

View reviewed changes

ghost added the Progress: ready for testing label Mar 24, 2019

magento-engcom-team added Component: View and removed Component: Framework/View labels Mar 24, 2019

soleksii self-assigned this Apr 2, 2019

ghost added Progress: testing in progress and removed Progress: ready for testing labels Apr 2, 2019

ghost added Progress: extended testing and removed Progress: testing in progress labels Apr 2, 2019

p-bystritsky self-assigned this Apr 2, 2019

ghost added Progress: accept and removed Progress: extended testing labels Apr 5, 2019

magento-engcom-team merged commit ea89448 into magento:2.3-develop Apr 8, 2019

magento-engcom-team added this to the Release: 2.3.2 milestone Apr 8, 2019

magento-engcom-team pushed a commit that referenced this pull request Apr 8, 2019

ENGCOM-4563: Update typeReferenceBlock definition #18933

ea6cd11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update typeReferenceBlock definition #18933

Update typeReferenceBlock definition #18933

leandrommedeiros commented Oct 29, 2018

magento-cicd2 commented Oct 29, 2018 •

edited

Loading

magento-engcom-team commented Oct 29, 2018

orlangur commented Oct 29, 2018

buskamuza commented Oct 30, 2018

sivaschenko commented Nov 12, 2018

orlangur commented Nov 12, 2018

sidolov commented Nov 28, 2018

sivaschenko commented Jan 10, 2019

sivaschenko commented Jan 15, 2019

orlangur left a comment

magento-engcom-team commented Mar 24, 2019

magento-engcom-team commented Mar 24, 2019

soleksii commented Apr 2, 2019

m2-assistant bot commented Apr 8, 2019

Update typeReferenceBlock definition #18933

Update typeReferenceBlock definition #18933

Conversation

leandrommedeiros commented Oct 29, 2018

Description (*)

Manual testing scenarios (*)

Contribution checklist (*)

magento-cicd2 commented Oct 29, 2018 • edited Loading

magento-engcom-team commented Oct 29, 2018

orlangur commented Oct 29, 2018

buskamuza commented Oct 30, 2018

sivaschenko commented Nov 12, 2018

orlangur commented Nov 12, 2018

sidolov commented Nov 28, 2018

sivaschenko commented Jan 10, 2019

sivaschenko commented Jan 15, 2019

orlangur left a comment

Choose a reason for hiding this comment

magento-engcom-team commented Mar 24, 2019

magento-engcom-team commented Mar 24, 2019

soleksii commented Apr 2, 2019

m2-assistant bot commented Apr 8, 2019

magento-cicd2 commented Oct 29, 2018 •

edited

Loading