Create Custom Widget Error Message

Hi,

How do I create a custom widget error message?

I want to change this error message to something more meaningful.

This is what I have now. But error message is only displayed after I refresh the page.

PHP

$msg = 'Please select a tag!'; $this->container->get('session')->getFlashBag()->add('error', $msg); throw new \Exception($msg);

1 2 3

$msg = 'Please select a tag!';             $this->container->get('session')->getFlashBag()->add('error', $msg);             throw new \Exception($msg);

Topic

[ykasenkaParticipant]

Hello

By default, it is no possible to customize error message when server returns 500 code. Please wrap you code by try-catch and pass error message to your widget template.

[ykasenkaParticipant]

Example
controller:

PHP

public function updateAction() { try { throw new \Exception('My Exception Message'); // action implementaion } catch (\Exception $e) { return ['exception' => $e->getMessage()]; } }

1 2 3 4 5 6 7 8 9 10

public function updateAction()     {         try {             throw new \Exception('My Exception Message');               // action implementaion         } catch (\Exception $e) {             return ['exception' => $e->getMessage()];         }     }

twig:

{# Resources/.../views/widget/update.html.twig #} <div class="widget-content" data-page-component-module="orofrontend/js/app/components/widget-form-component"> {% if exception is defined %} <div class="widget-content"> <div class="alert alert-error">{{ exception }}</div> </div> {% endif %} {# form fields #} </div>

1 2 3 4 5 6 7 8 9 10

{# Resources/.../views/widget/update.html.twig #} <div class="widget-content"      data-page-component-module="orofrontend/js/app/components/widget-form-component">     {% if exception is defined %}         <div class="widget-content">             <div class="alert alert-error">{{ exception }}</div>         </div>     {% endif %}     {# form fields #} </div>

[ykasenkaParticipant]

@zhex900, did you get an answer to your question?

[zhex900Participant]

I want to throw the exception other places not just in the controller. For example EventListeners, Managers. Where do I add the twig you suggested? Basically, I want to have a way to display error messages.

[ykasenkaParticipant]

For wrap exceptions for dialogs globally, you need create and register exception listener, like that:

PHP

my_bundle.event_listener.exception_listener: class: MyBundle\EventListener\ExceptionListener tags: - { name: kernel.event_listener, event: kernel.exception }

1 2 3 4

my_bundle.event_listener.exception_listener:         class: MyBundle\EventListener\ExceptionListener         tags:             - { name: kernel.event_listener, event: kernel.exception }

PHP

class ExceptionListener { /** * @param GetResponseForExceptionEvent $event */ public function onKernelException(GetResponseForExceptionEvent $event) { if ($event->getRequest()->isXmlHttpRequest()) { $e = $event->getException(); $event->setResponse( new JsonResponse([ 'exception' => [ 'message' => $e->getMessage() ] ], Response::HTTP_INTERNAL_SERVER_ERROR ) ); } } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

class ExceptionListener {     /**      * @param GetResponseForExceptionEvent $event      */     public function onKernelException(GetResponseForExceptionEvent $event)     {         if ($event->getRequest()->isXmlHttpRequest()) {             $e = $event->getException();             $event->setResponse(                 new JsonResponse([                         'exception' => [                             'message' => $e->getMessage()                         ]                     ],                     Response::HTTP_INTERNAL_SERVER_ERROR                 )             );         }     } }

create you widget (extended from “oro/dialog-widget”), overwrite current logic, and register it instead of “oro/dialog-widget” on you bundle (see method _onContentLoadFail), like that:

YAML

#Resources/configs/requirejs.yml config: paths: # backup original widget 'orowindows/js/widget/dialog-widget': 'orowindows/js/widget/dialog-widget' # overwrite original widget 'oro/dialog-widget': 'mybundle/js/widget/dialog-widget'

1 2 3 4 5 6 7

#Resources/configs/requirejs.yml config:     paths:         # backup original widget         'orowindows/js/widget/dialog-widget': 'orowindows/js/widget/dialog-widget'         # overwrite original widget         'oro/dialog-widget': 'mybundle/js/widget/dialog-widget'

JavaScript

//Resources/public/js/widget/dialog-widget.js define(function(require) { 'use strict'; var DialogWidget; var BaseWidget = require('orowindows/js/widget/dialog-widget'); DialogWidget = BaseWidget.extend({ /** * @inheritDoc */ _onContentLoadFail: function(jqxhr) { // you own logic for show error messages var message = jqxhr.responseJSON.exception.message; var failContent = '<div class="widget-content">' + '<div class="alert alert-error">' + message + '</div>' + '</div>'; this._onContentLoad(failContent); } }); return DialogWidget; });

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

//Resources/public/js/widget/dialog-widget.js define(function(require) {     'use strict';       var DialogWidget;     var BaseWidget = require('orowindows/js/widget/dialog-widget');       DialogWidget = BaseWidget.extend({         /**          * @inheritDoc          */         _onContentLoadFail: function(jqxhr) {             // you own logic for show error messages             var message = jqxhr.responseJSON.exception.message;               var failContent = '<div class="widget-content">' +                 '<div class="alert alert-error">' + message + '</div>' +                 '</div>';               this._onContentLoad(failContent);           }     });       return DialogWidget; });

[ykasenkaParticipant]

@zhex900, this time did you get an answer to your question?

[zhex900Participant]

Yes. Thank you!

[Author]

Replies