Edit this page on GitHub

Shopware event list

If you want to hook onto Shopware you need to know the events. For more about events, see the event guide. The following list will give an overview of the existing events and how to subscribe to them.

Enlight_Controller_Front_StartDispatch

Definition

public function dispatch()
{
    ...
    $this->eventManager->notify(
        'Enlight_Controller_Front_StartDispatch',
        $eventArgs
    );
    ...
}

Registration

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Front_StartDispatch' => 'onEnlightControllerFrontStartDispatch'
    ];
}

Listener

public function onEnlightControllerFrontStartDispatch(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Front */
    $enlightController = $arguments->getSubject();
}

Arguments dump

stdClass Object
(
    [__CLASS__] => Enlight_Controller_EventArgs
    [_processed] => 
    [_name] => Enlight_Controller_Front_StartDispatch
    [_return] => 
    [_elements] => Array
        (
            [subject] => stdClass Object
                (
                    [__CLASS__] => Shopware_Proxies_EnlightControllerFrontProxy
                    [plugins] => Enlight_Plugin_Namespace_Loader
                    [router] => 
                    [dispatcher] => Enlight_Controller_Dispatcher_Default
                    [request] => 
                    [response] => Enlight_Controller_Response_ResponseHttp
                    [throwExceptions] => 
                    [returnResponse] => 
                    [invokeParams] => Array(7)
                    [instances] => Array(0)
                )
        )
)

Enlight_Controller_Front_RouteStartup

public function dispatch()
{
    ...
    $this->eventManager->notify(
        'Enlight_Controller_Front_StartDispatch',
        $eventArgs
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Front_RouteStartup' => 'onEnlightControllerFrontRouteStartup'
    ];
}

public function onEnlightControllerFrontRouteStartup(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Front */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Controller_Router_Route

public function match($pathInfo, Context $context)
{
    ...
    $event = $this->eventManager->notifyUntil('Enlight_Controller_Router_Route', [
        //'subject' => $router, @deprecated someone need it?
        'request' => $request,
        'context' => $context,
    ]
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Router_Route' => 'onEnlightControllerRouteRoute'
    ];
}

public function onEnlightControllerRouteRoute(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Router_Default */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();
}

stdClass Object
(
    [__CLASS__] => Enlight_Event_EventArgs
    [_processed] => 
    [_name] => Enlight_Controller_Router_Route
    [_return] => 
    [_elements] => Array
        (
            [subject] => stdClass Object
                (
                    [__CLASS__] => Enlight_Controller_Router_Default
                    [front] => Shopware_Proxies_EnlightControllerFrontProxy
                    [separator] => /
                    [globalParams] => Array(0)
                    [instances] => Array(0)
                )

            [request] => stdClass Object
                (
                    [__CLASS__] => Enlight_Controller_Request_RequestHttp
                    [_paramSources] => Array(2)
                    [_requestUri] => /sw406/
                    [_baseUrl] => /sw406
                    [_basePath] => /sw406
                    [_pathInfo] => /
                    [_params] => Array(0)
                    [_rawBody] => 
                    [_aliases] => Array(0)
                    [_dispatched] => 
                    [_module] => 
                    [_moduleKey] => module
                    [_controller] => 
                    [_controllerKey] => controller
                    [_action] => 
                    [_actionKey] => action
                )
        )
)

Enlight_Controller_Front_RouteShutdown

public function dispatch()
{
    ...
    $this->eventManager->notify(
        'Enlight_Controller_Front_RouteStartup',
        $eventArgs
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Front_RouteShutdown' => 'onEnlightControllerFrontRouteShutdown'
    ];
}

public function onEnlightControllerFrontRouteShutdown(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Front */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Controller_Front_DispatchLoopStartup

public function dispatch()
{
    ...
    $this->eventManager->notify(
        'Enlight_Controller_Front_DispatchLoopStartup',
        $eventArgs
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Front_DispatchLoopStartup' => 'onEnlightControllerFrontDispatchLoopStartup'
    ];
}

public function onEnlightControllerFrontDispatchLoopStartup(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Front */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Controller_Front_PreDispatch

public function dispatch()
{
    ...
    $this->eventManager->notify(
        'Enlight_Controller_Front_PreDispatch',
        $eventArgs
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Front_PreDispatch' => 'onEnlightControllerFrontPreDispatch'
    ];
}

public function onEnlightControllerFrontPreDispatch(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Front */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Controller_Action_PreDispatch*

public function dispatch($action)
{
    ...
    Shopware()->Events()->notify(
        __CLASS__ . '_PreDispatch',
        $args
    );

    Shopware()->Events()->notify(
        __CLASS__ . '_PreDispatch_' . $moduleName,
        $args
    );

    Shopware()->Events()->notify(
        __CLASS__ . '_PreDispatch_' . $this->controller_name,
        $args
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Action_PreDispatch_Frontend_Detail' => 'onEnlightControllerActionPreDispatchFrontendDetail'
    ];
}

public function onEnlightControllerActionPreDispatchFrontendDetail(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Action */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Controller_Action_PostDispatch* and Enlight_Controller_Action_PostDispatchSecure*

public function dispatch($action)
{
    ...
    if ($this->Request()->isDispatched()
        && !$this->Response()->isException()
        && $this->View()->hasTemplate()
    ) {
        Shopware()->Events()->notify(
            __CLASS__ . '_PostDispatchSecure_' . $this->controller_name,
            $args
        );

        Shopware()->Events()->notify(
            __CLASS__ . '_PostDispatchSecure_' . $moduleName,
            $args
        );

        Shopware()->Events()->notify(
            __CLASS__ . '_PostDispatchSecure',
            $args
        );
    }

    // fire non-secure/legacy-PostDispatch-Events
    Shopware()->Events()->notify(
        __CLASS__ . '_PostDispatch_' . $this->controller_name,
        $args
    );

    Shopware()->Events()->notify(
        __CLASS__ . '_PostDispatch_' . $moduleName,
        $args
    );

    Shopware()->Events()->notify(
        __CLASS__ . '_PostDispatch',
        $args
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Action_PostDispatch_Frontend_Detail' => 'onEnlightControllerActionPostDispatchFrontendDetail'
    ];
}

public function onEnlightControllerActionPostDispatchFrontendDetail(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Action */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Plugins_ViewRenderer_PreRender

public function renderTemplate($template, $name = null)
{
    ...
    $this->Application()->Events()->notify(
        'Enlight_Plugins_ViewRenderer_PreRender',
        array(
            'subject' => $this,
            'template' => $template,
            'request' => $this->Action()->Request()
        )
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Plugins_ViewRenderer_PreRender' => 'onEnlightPluginsViewRendererPreRender'
    ];
}

public function onEnlightPluginsViewRendererPreRender(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightPlugin Enlight_Controller_Plugins_ViewRenderer_Bootstrap */
    $enlightPlugin = $arguments->getSubject();

    /** @var $template Enlight_Template_Default */
    $template = $arguments->getTemplate();
}

stdClass Object
(
    [__CLASS__] => Enlight_Event_EventArgs
    [_processed] => 
    [_name] => Enlight_Plugins_ViewRenderer_PreRender
    [_return] => 
    [_elements] => Array
        (
            [subject] => stdClass Object
                (
                    [__CLASS__] => Enlight_Controller_Plugins_ViewRenderer_Bootstrap
                    [neverRender] => 
                    [noRender] => 
                    [front] => Shopware_Proxies_EnlightControllerFrontProxy
                    [action] => Shopware_Proxies_ShopwareControllersFrontendIndexProxy
                    [engine] => Enlight_Template_Manager
                    [name] => ViewRenderer
                    [collection] => Enlight_Plugin_Namespace_Loader
                    [instances] => Array(0)
                )

            [template] => stdClass Object
                (
                    [__CLASS__] => Enlight_Template_Default
                    [cache_id] => 
                    [compile_id] => frontend_emotion_orange_de_DE_1
                    [caching] => 
                    [cache_lifetime] => 3600
                    [template_resource] => 
                    [mustCompile] => 
                    [has_nocache_code] => 
                    [properties] => Array(3)
                    [required_plugins] => Array(2)
                    [smarty] => Enlight_Template_Manager
                    [block_data] => Array(1)
                    [variable_filters] => Array(0)
                    [used_tags] => Array(0)
                    [allow_relative_path] => 
                    [_capture_stack] => Array(1)
                    [template_class] => Smarty_Internal_Template
                    [tpl_vars] => Array(28)
                    [parent] => Enlight_Template_Manager
                    [config_vars] => Array(0)
                )
        )
)

Enlight_Plugins_ViewRenderer_FilterRender

public function renderTemplate($template, $name = null)
{
    ...
    $render = $this->Application()->Events()->filter(
        'Enlight_Plugins_ViewRenderer_FilterRender',
        $render,
        array('subject' => $this, 'template' => $template)
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Plugins_ViewRenderer_FilterRender' => 'onEnlightPluginsViewRendererFilterRender'
    ];
}

public function onEnlightPluginsViewRendererFilterRender(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightPlugin Enlight_Controller_Plugins_ViewRenderer_Bootstrap */
    $enlightPlugin = $arguments->getSubject();

    /** @var $template Enlight_Template_Default */
    $template = $arguments->getTemplate();
}

stdClass Object
(
    [__CLASS__] => Enlight_Event_EventArgs
    [_processed] => 
    [_name] => Enlight_Plugins_ViewRenderer_FilterRender
    [_return] => 

    [_elements] => Array
        (
            [subject] => stdClass Object
                (
                    [__CLASS__] => Enlight_Controller_Plugins_ViewRenderer_Bootstrap
                    [neverRender] => 
                    [noRender] => 
                    [front] => Shopware_Proxies_EnlightControllerFrontProxy
                    [action] => Shopware_Proxies_ShopwareControllersWidgetsIndexProxy
                    [engine] => Enlight_Template_Manager
                    [name] => ViewRenderer
                    [collection] => Enlight_Plugin_Namespace_Loader
                    [instances] => Array(0)
                )

            [template] => stdClass Object
                (
                    [__CLASS__] => Enlight_Template_Default
                    [cache_id] => 
                    [compile_id] => frontend_emotion_orange_de_DE_1
                    [caching] => 
                    [cache_lifetime] => 3600
                    [template_resource] => widgets/index/menu.tpl
                    [mustCompile] => 
                    [has_nocache_code] => 
                    [properties] => Array(5)
                    [required_plugins] => Array(2)
                    [smarty] => Enlight_Template_Manager
                    [block_data] => Array(0)
                    [variable_filters] => Array(0)
                    [used_tags] => Array(0)
                    [allow_relative_path] => 
                    [_capture_stack] => Array(1)
                    [template_class] => Smarty_Internal_Template
                    [tpl_vars] => Array(2)
                    [parent] => Enlight_Template_Manager
                    [config_vars] => Array(0)
                )
        )
)

Enlight_Plugins_ViewRenderer_PostRender

public function renderTemplate($template, $name = null)
{
    ...
    $this->Application()->Events()->notify(
        'Enlight_Plugins_ViewRenderer_PostRender',
        array('subject' => $this, 'template' => $template)
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Plugins_ViewRenderer_PostRender' => 'onEnlightPluginsViewRendererPostRender'
    ];
}

public function onEnlightPluginsViewRendererPostRender(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightPlugin Enlight_Controller_Plugins_ViewRenderer_Bootstrap */
    $enlightPlugin = $arguments->getSubject();

    /** @var $template Enlight_Template_Default */
    $template = $arguments->getTemplate();
}

stdClass Object
(
    [__CLASS__] => Enlight_Event_EventArgs
    [_processed] => 
    [_name] => Enlight_Plugins_ViewRenderer_PostRender
    [_return] => 
    [_elements] => Array
        (
            [subject] => stdClass Object
                (
                    [__CLASS__] => Enlight_Controller_Plugins_ViewRenderer_Bootstrap
                    [neverRender] => 
                    [noRender] => 
                    [front] => Shopware_Proxies_EnlightControllerFrontProxy
                    [action] => Shopware_Proxies_ShopwareControllersWidgetsIndexProxy
                    [engine] => Enlight_Template_Manager
                    [name] => ViewRenderer
                    [collection] => Enlight_Plugin_Namespace_Loader
                    [instances] => Array(0)
                )

            [template] => stdClass Object
                (
                    [__CLASS__] => Enlight_Template_Default
                    [cache_id] => 
                    [compile_id] => frontend_emotion_orange_de_DE_1
                    [caching] => 
                    [cache_lifetime] => 3600
                    [template_resource] => widgets/index/menu.tpl
                    [mustCompile] => 
                    [has_nocache_code] => 
                    [properties] => Array(5)
                    [required_plugins] => Array(2)
                    [smarty] => Enlight_Template_Manager
                    [block_data] => Array(0)
                    [variable_filters] => Array(0)
                    [used_tags] => Array(0)
                    [allow_relative_path] => 
                    [_capture_stack] => Array(1)
                    [template_class] => Smarty_Internal_Template
                    [tpl_vars] => Array(2)
                    [parent] => Enlight_Template_Manager
                    [config_vars] => Array(0)
                )
        )
)

Enlight_Controller_Front_PostDispatch

public function dispatch()
{
    ...
    $this->eventManager->notify(
        'Enlight_Controller_Front_PostDispatch',
        $eventArgs
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Front_PostDispatch' => 'onEnlightControllerFrontPostDispatch'
    ];
}

public function onEnlightControllerFrontPostDispatch(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Front */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Controller_Front_DispatchLoopShutdown

public function dispatch()
{
    ...
    $this->eventManager->notify(
        'Enlight_Controller_Front_DispatchLoopShutdown',
        $eventArgs
    );
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Front_DispatchLoopShutdown' => 'onEnlightControllerFrontDispatchLoopShutdown'
    ];
}

public function onEnlightControllerFrontDispatchLoopShutdown(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Front */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();

    /** @var $response Enlight_Controller_Response_ResponseHttp */
    $response = $arguments->getResponse();
}

Enlight_Controller_Dispatcher_ControllerPath_*

public function getControllerPath(Enlight_Controller_Request_Request $request)
{
    ...
    if ($event = Shopware()->Events()->notifyUntil(
            'Enlight_Controller_Dispatcher_ControllerPath_' . $moduleName . '_' . $controllerName,
            ['subject' => $this, 'request' => $request]
            )
    ) {
        $path = $event->getReturn();
    } else {
        $path = $this->curDirectory . $controllerName . '.php';
    }
    ...
}

public static function getSubscribedEvents()
{
    return [
        'Enlight_Controller_Dispatcher_ControllerPath_Frontend_Detail' => 'onEnlightControllerDispatcherControllerPathFrontendDetail'
    ];
}

public function onEnlightControllerDispatcherControllerPathFrontendDetail(\Enlight_Event_EventArgs $arguments)
{
    /** @var $enlightController Enlight_Controller_Dispatcher_Default */
    $enlightController = $arguments->getSubject();

    /** @var $request Enlight_Controller_Request_RequestHttp */
    $request = $arguments->getRequest();
}

stdClass Object
(
    [__CLASS__] => Enlight_Event_EventArgs
    [_processed] => 
    [_name] => Enlight_Controller_Dispatcher_ControllerPath_Frontend_Detail
    [_return] => 
    [_elements] => Array
        (
            [subject] => stdClass Object
                (
                    [__CLASS__] => Enlight_Controller_Dispatcher_Default
                    [curDirectory] => /var/www/sw406/engine/Shopware/Controllers/Frontend/
                    [curModule] => frontend
                    [defaultAction] => index
                    [defaultController] => index
                    [defaultModule] => frontend
                    [frontController] => 
                    [pathDelimiter] => _
                    [wordDelimiter] => Array(2)
                    [controllerDirectory] => Array(4)
                    [front] => Shopware_Proxies_EnlightControllerFrontProxy
                    [response] => Enlight_Controller_Response_ResponseHttp
                    [instances] => Array(0)
                )

            [request] => stdClass Object
                (
                    [__CLASS__] => Enlight_Controller_Request_RequestHttp
                    [_paramSources] => Array(2)
                    [_requestUri] => /sw406/sommerwelten/accessoires/170/sonnenbrille-red
                    [_baseUrl] => /sw406
                    [_basePath] => /sw406
                    [_pathInfo] => /sommerwelten/accessoires/170/sonnenbrille-red
                    [_params] => Array(4)
                    [_rawBody] => 
                    [_aliases] => Array(1)
                    [_dispatched] => 1
                    [_module] => frontend
                    [_moduleKey] => module
                    [_controller] => detail
                    [_controllerKey] => controller
                    [_action] => 
                    [_actionKey] => action
                )
        )
)

Theme_Inheritance_Template_Directories_Collected

public function getTemplateDirectories(Shop\Template $template)
{
    $directories = $this->getTemplateDirectoriesRecursive(
        $template->getId(),
        $this->fetchTemplates()
    );

    $directories = $this->eventManager->filter(
        'Theme_Inheritance_Template_Directories_Collected',
        $directories,
        ['template' => $template]
    );

    return $directories;
}

public static function getSubscribedEvents()
{
    return [
        'Theme_Inheritance_Template_Directories_Collected' => 'onCollectTemplateDirectories',
    ];
}

public function onCollectTemplateDirectories(\Enlight_Event_EventArgs $args)
{
    /** @var $directories array */
    $directories = $args->getReturn();

    /** @var $template \Shopware\Models\Shop\Template */
    $template = $args->get('template');

    // adding own plugin view directory ($this->pluginDirectory contains plugin path)
    $directories[] = $this->pluginDirectory . '/Resources/views';

    $args->setReturn($directories);
}

stdClass object
(
    [__CLASS__] => Enlight_Event_EventArgs
    [_processed] => 
    [_name] => Theme_Inheritance_Template_Directories_Collected
    [_return] => Array (
        [0] => /var/www/html/themes/Frontend/Responsive
        [1] => /var/www/html/themes/Frontend/Bare
    )
    [_elements] => Array(
        [template] => Shopware\Models\Shop\Template
    )
)

Top

Search results