Create a list of notified events in Shopware 5

Apr 14, 2018 PHP Shopware

Shopware best practice while developing is to use events if you want to change or add the behavior of the shop. Some developers are often searching for full event lists of a system. But in the most cases are those lists incomplete. The main reason are dynamic events. It is always a good idea to create a fresh event list for every development task that desires events.

Logging a Shopware event list

Just add the following code line to the method notify of the class Enlight_Event_EventManager.

public function notify($event, $eventArgs = null)
{
    // START LOG CHANGES
    file_put_contents('./var/log/events.log', $event . "\n", FILE_APPEND);
    // END LOG CHANGES
    if (!$this->hasListeners($event)) {
        return null;
    }

    $eventArgs = $this->buildEventArgs($eventArgs);
    $eventArgs->setReturn(null);
    $eventArgs->setName($event);
    $eventArgs->setProcessed(false);

    foreach ($this->getListeners($event) as $listener) {
        $listener->execute($eventArgs);
    }
    $eventArgs->setProcessed(true);

    return $eventArgs;
}

Run you target action afterwards. For example placing an order or visting a category page. Remove the logging line from above immediately and take a look at the file var/log/events.log. The file should contain all notified events during the executed action.

Shopware events list on detail page

Here a example list of all notified events during a detail page visit of an article. The list is also available as events.txt for download.