Optimization of the frontend link button in SonataAdmin

- Added translation
- Shortened caption and added title
- Routes can now also be linked to the frontend
- Improved exception handling

Author: frne

Admin/Extension/FrontendLinkExtension.php

@@ -14,9 +14,11 @@
 use Knp\Menu\ItemInterface as MenuItemInterface;
 use Sonata\AdminBundle\Admin\AdminExtension;
 use Sonata\AdminBundle\Admin\AdminInterface;
-use Sonata\AdminBundle\Form\FormMapper;
+use Symfony\Bundle\FrameworkBundle\Translation\Translator;
 use Symfony\Cmf\Component\Routing\RouteReferrersReadInterface;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+use Symfony\Component\Routing\Exception\ExceptionInterface as RoutingExceptionInterface;
+use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouterInterface;
 
 /**
@@ -32,12 +34,19 @@ class FrontendLinkExtension extends AdminExtension
      */
     private $router;
 
+    /**
+     * @var Translator
+     */
+    private $translator;
+
     /**
      * @param RouterInterface $router
+     * @param Translator $translator
      */
-    public function __construct(RouterInterface $router)
+    public function __construct(RouterInterface $router, Translator $translator)
     {
         $this->router = $router;
+        $this->translator = $translator;
     }
 
     public function configureTabMenu(
@@ -50,18 +59,32 @@ public function configureTabMenu(
             return;
         }
 
-        if (!$subject instanceof RouteReferrersReadInterface) {
+        if (!$subject instanceof RouteReferrersReadInterface && !$subject instanceof Route) {
             throw new InvalidConfigurationException(
                 sprintf(
-                    '%s can only be used on subjects which implement Symfony\Cmf\Component\Routing\RouteReferrersReadInterface!',
+                    '%s can only be used on subjects which implement Symfony\Cmf\Component\Routing\RouteReferrersReadInterface or Symfony\Component\Routing\Route!',
                     __CLASS__
                 )
             );
         }
 
-        $uri = $this->router->generate($subject);
+        try {
+            $uri = $this->router->generate($subject);
+        } catch (RoutingExceptionInterface $e) {
+            // we have no valid route
+            return;
+        }
 
-        $menu->addChild('Open in frontend', array('uri' => $uri, 'linkAttributes' => array('target' => '_blank')));
+        $menu->addChild(
+            $this->translator->trans('admin.menu_frontend_link_caption', array(), 'CmfRoutingBundle'),
+            array(
+                'uri' => $uri,
+                'linkAttributes' => array(
+                    'target' => '_blank',
+                    'title' => $this->translator->trans('admin.menu_frontend_link_title', array(), 'CmfRoutingBundle')
+                )
+            )
+        );
     }
 
 }

Resources/config/admin-phpcr.xml

@@ -59,6 +59,7 @@
         <service id="cmf_routing.admin_extension.frontend_link" class="%cmf_routing.admin_extension.frontend_link.class%">
             <tag name="sonata.admin.extension"/>
             <argument type="service" id="cmf_routing.router"/>
+            <argument type="service" id="translator"/>
         </service>
 
     </services>

Resources/translations/CmfRoutingBundle.de.xliff

@@ -132,6 +132,14 @@
             ]]>
         </target>
       </trans-unit>
+      <trans-unit id="admin.menu_frontend_link_caption">
+        <source>admin.menu_frontend_link_caption</source>
+        <target>Frontend</target>
+      </trans-unit>
+      <trans-unit id="admin.menu_frontend_link_title">
+        <source>admin.menu_frontend_link_title</source>
+        <target>Frontend-Ansicht in neuem Tab öffnen</target>
+      </trans-unit>
     </body>
   </file>
 </xliff>

Resources/translations/CmfRoutingBundle.en.xliff

@@ -132,6 +132,14 @@
             ]]>
         </target>
       </trans-unit>
+      <trans-unit id="admin.menu_frontend_link_caption">
+        <source>admin.menu_frontend_link_caption</source>
+        <target>Frontend</target>
+      </trans-unit>
+      <trans-unit id="admin.menu_frontend_link_title">
+        <source>admin.menu_frontend_link_title</source>
+        <target>Open frontend view in new tab</target>
+      </trans-unit>
     </body>
   </file>
 </xliff>