[#37978] - Improved MVC events
- Closed
- 2 Jul 2022
- Medium
- Build: 4.1-dev
- # 37978
- Diff
- Denitz:MVC_model_events
User tests: Successful: Unsuccessful:
Summary of Changes
events_mapproperty moved fromFormModeltoBaseDatabaseModelbecause the property is shared by multiple inheritors.- All
eventClassparams ofAbstractEvent::create()calls are shortened to useClassname::classnotation instead of using string event classname (easier to find all event class usages vide IDE in 2022). onAfterDisplayevent can modify the output now.- New
ListQueryEventclass andonContentListQueryevent to modify the list query before executing. - New
AfterGetListEventclass andonContentAfterGetListevent to modify the list of items after load from database.
Testing Instructions
- Apply patch, try to play with custom events via your plugin, i.e.
// All views return 'my custom HTML'
public function onAfterDisplay(DisplayEvent $event)
{
$event->setArgument('source', 'my custom HTML');
}
// All lists are ordered by `a.id`
public function onContentListQuery(DisplayEvent $event)
{
$event->getArgument('query')->order('a.id');
}
// All lists' titles are 'OK'
public function onContentAfterGetList(AfterGetListEvent $event)
{
foreach($event->getArgument('list') as $item)
{
$item->title = 'OK';
}
}
Actual result BEFORE applying this Pull Request
Core Joomla is barely extendable.
Expected result AFTER applying this Pull Request
Core Joomla is extendable.
Documentation Changes Required
No.
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Administration com_content com_installer com_modules com_plugins Libraries Front End Plugins |
Is this backwards compatible?
@brianteeman Yes, it only adds the new functionality. I can add the same code in Joomla 3 but won't be accepted :)
@Denitz New functionality should go into 4.2, if backwards compatible. So this PR should be rebased to the 4.2-dev branch. Let us know if you need help with that.
After rebase, the PR might show unrelated changes on GitHub, but that will go away after the next update of the 4.2-dev branch with the latest changes on the 4.1-dev branch (so-called "upmerge") and after that an update of your branch for this PR to the latest 4.2-dev here.
| Labels |
Added:
?
|
||
| Category | Administration com_content com_installer com_modules com_plugins Libraries Front End Plugins | ⇒ | Unit Tests Repository Administration com_admin SQL |
| Labels |
Added:
?
|
||
@richard67 Rebased
| Labels |
Added:
?
Removed: ? |
||
| Category | Administration Unit Tests Repository com_admin SQL | ⇒ | Administration com_content com_installer com_modules com_plugins Libraries Front End Plugins |
| Labels |
Removed:
?
|
||
Drone fails because xmlreader is not installed for PHP 8.1, can somebody fix it?
Drone fails because
xmlreaderis not installed for PHP 8.1, can somebody fix it?
Have contacted maintainers to check.
Is it possible to restart drone?
Is it possible to restart drone?
@Denitz I have done that recently a few times, but the tests fail all at the same step: Logging in to admin after a new installation. Have you tested this yourself, making a new installation with your PR applied, and then logging in to backend? I'll restart drone now but I do not really expect new results.
There is a reason why we don't have a listquery event because it creates more then it solves. This has discussed several times.
Also the modification of the result is questionable. Because we easily generate more problems then expected.
| Status | Pending | ⇒ | Closed |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2022-06-14 08:43:46 |
| Closed_By | ⇒ | Denitz |
Would you mind to open a new pr which removes the hard codec class paths?
I removed onContentListQuery event, though I totally disagree.
| Status | Closed | ⇒ | New |
| Closed_Date | 2022-06-14 08:43:46 | ⇒ | |
| Closed_By | Denitz | ⇒ |
| Status | New | ⇒ | Pending |
This pull requests has been automatically converted to the PSR-12 coding standard.
| Labels |
Added:
?
|
||
| Status | Pending | ⇒ | Closed |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2022-07-02 10:10:38 |
| Closed_By | ⇒ | Denitz |
Is this backwards compatible?