[#34062] - [4] Correctly return from display method, correct the doc for that too - manually.
- Fixed in Code Base
- 5 Jul 2021
- Medium
- Build: 4.0-dev
- # 34062
- Diff
- PhilETaylor:returnparentdisplay
User tests: Successful: Unsuccessful:
Summary of Changes
Not a typo. 70 changed files with 128 additions and 124 deletions.
Not a simple search and replace of everything.
parent::display() in most extensions HtmlView.php files calls \Joomla\CMS\MVC\View::display() as parent::display() which finally echo's a $result.
An echo is not a return, so the second parent::display() returns void to the first, which then doesnt return anything (correctly returns void already) back to the HTMLView and so its plainly wrong to again then return the non-existing void back up the call stack.
Therefore return parent::display($tpl) is simply wrong, proved by removing the return in this PR.
This PR then updates the docblocks correctly.
THERE ARE A COUPLE OF GOTCHAS, this is not a simple search and replace.
Testing Instructions
Code review
Apply PR - Joomla still works.
note...
This is different to the use of return parent::display(); in Controllers which is correct, as that is returning an instance of BaseController to provide a fluid interface for chaining methods. Whereas this is not the case in the views.
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Administration com_cache com_categories com_checkin com_config com_contact com_content com_contenthistory com_cpanel com_fields com_finder com_languages com_media com_messages |
rdeutz
- | Title |
|
||||||
| Labels |
Added:
?
|
||
| Category | Administration com_cache com_categories com_checkin com_config com_contact com_content com_contenthistory com_cpanel com_fields com_finder com_languages com_media com_messages | ⇒ | Administration com_cache com_categories com_checkin com_config com_contact com_content com_contenthistory com_cpanel com_fields com_finder |
| Category | Administration com_cache com_categories com_checkin com_config com_contact com_content com_contenthistory com_cpanel com_fields com_finder | ⇒ | Administration com_cache com_categories com_checkin com_config com_contact com_content com_contenthistory com_cpanel com_fields com_finder com_languages com_media com_messages |
| Status | Pending | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2021-07-05 15:23:10 |
| Closed_By | ⇒ | wilsonge |
This will do as a starting point. The exception handling is much more tricky and a bigger piece of work - think this is good enough standalone.
rebased after @brianteeman preparedocument PR to fix my conflicts.