Merge pull request #469 from lunika/breadcrumb

manage breadcrumb on images and documents

core/lib/Thelia/Config/Resources/routing/admin.xml

@@ -16,7 +16,7 @@
         <default key="_controller">Thelia\Controller\Admin\HomeController::defaultAction</default>
     </route>
 
-    <route id="admin.home.view" path="/admin/latest-thelia-version">
+    <route id="admin.home.latestVersion" path="/admin/latest-thelia-version">
         <default key="_controller">Thelia\Controller\Admin\HomeController::getLatestTheliaVersion</default>
     </route>
 
@@ -466,7 +466,7 @@
         <default key="_controller">Thelia\Controller\Admin\ContentController::createAction</default>
     </route>
 
-    <route id="admin.content.update" path="admin/content/update/{content_id}">
+    <route id="admin.content.update" path="/admin/content/update/{content_id}">
         <default key="_controller">Thelia\Controller\Admin\ContentController::updateAction</default>
         <requirement key="content_id">\d+</requirement>
     </route>

core/lib/Thelia/Controller/Admin/FileController.php

@@ -312,7 +312,8 @@ class FileController extends BaseAdminController
                 'imageId' => $imageId,
                 'imageType' => $parentType,
                 'redirectUrl' => $redirectUrl,
-                'formId' => $fileManager->getFormId($parentType, FileManager::FILE_TYPE_IMAGES)
+                'formId' => $fileManager->getFormId($parentType, FileManager::FILE_TYPE_IMAGES),
+                'breadcrumb' => $image->getBreadcrumb($this->getRouter($this->getCurrentRouter()), $this->container, 'images')
             ));
         } catch (\Exception $e) {
             $this->pageNotFound();
@@ -341,7 +342,8 @@ class FileController extends BaseAdminController
                     'documentId' => $documentId,
                     'documentType' => $parentType,
                     'redirectUrl' => $redirectUrl,
-                    'formId' => $fileManager->getFormId($parentType, FileManager::FILE_TYPE_DOCUMENTS)
+                    'formId' => $fileManager->getFormId($parentType, FileManager::FILE_TYPE_DOCUMENTS),
+                    'breadcrumb' => $document->getBreadcrumb($this->getRouter($this->getCurrentRouter()), $this->container, 'documents')
                 ));
         } catch (\Exception $e) {
             $this->pageNotFound();

core/lib/Thelia/Controller/BaseController.php

@@ -291,7 +291,7 @@ abstract class BaseController extends ContainerAware
     protected function getRouteFromRouter($routerName, $routeId, $parameters = array(), $referenceType = Router::ABSOLUTE_URL)
     {
         /** @var Router $router */
-        $router =  $this->container->get($routerName);
+        $router =  $this->getRouter($routerName);
 
         if ($router == null) {
             throw new \InvalidArgumentException(sprintf("Router '%s' does not exists.", $routerName));
@@ -300,6 +300,15 @@ abstract class BaseController extends ContainerAware
         return $router->generate($routeId, $parameters, $referenceType);
     }
 
+    /**
+     * @param $routerName
+     * @return Router
+     */
+    protected function getRouter($routerName)
+    {
+        return $this->container->get($routerName);
+    }
+
     /**
      * Return a 404 error
      * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException

core/lib/Thelia/Model/Breadcrumb/BreadcrumbInterface.php

@@ -0,0 +1,28 @@
+<?php
+/*************************************************************************************/
+/*      This file is part of the Thelia package.                                     */
+/*                                                                                   */
+/*      Copyright (c) OpenStudio                                                     */
+/*      email : dev@thelia.net                                                       */
+/*      web : http://www.thelia.net                                                  */
+/*                                                                                   */
+/*      For the full copyright and license information, please view the LICENSE.txt  */
+/*      file that was distributed with this source code.                             */
+/*************************************************************************************/
+
+namespace Thelia\Model\Breadcrumb;
+
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
+
+interface BreadcrumbInterface {
+
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab);
+}

core/lib/Thelia/Model/Breadcrumb/CatalogBreadcrumbTrait.php

@@ -0,0 +1,83 @@
+<?php
+/*************************************************************************************/
+/*      This file is part of the Thelia package.                                     */
+/*                                                                                   */
+/*      Copyright (c) OpenStudio                                                     */
+/*      email : dev@thelia.net                                                       */
+/*      web : http://www.thelia.net                                                  */
+/*                                                                                   */
+/*      For the full copyright and license information, please view the LICENSE.txt  */
+/*      file that was distributed with this source code.                             */
+/*************************************************************************************/
+
+namespace Thelia\Model\Breadcrumb;
+
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
+use Thelia\Core\Template\Loop\CategoryPath;
+use Thelia\Core\Translation\Translator;
+
+trait CatalogBreadcrumbTrait {
+
+    public function getBaseBreadcrumb(Router $router, ContainerInterface $container, $categoryId, &$locale)
+    {
+        $translator = Translator::getInstance();
+        $catalogUrl = $router->generate('admin.catalog', [], Router::ABSOLUTE_URL);
+        $breadcrumb = [
+            $translator->trans('Home', [], 'bo.default') => $router->generate('admin.home.view', [], Router::ABSOLUTE_URL),
+            $translator->trans('Catalog', [], 'bo.default') => $catalogUrl,
+        ];
+
+        $categoryPath = new CategoryPath($container);
+        $categoryPath->initializeArgs([
+                'category' => $categoryId,
+                'visible' => '*'
+            ]);
+
+        $results = $categoryPath->buildArray();
+
+        foreach ($results as $result) {
+            $breadcrumb[$result['TITLE']] =  sprintf("%s?category_id=%d",$catalogUrl, $result['ID']);
+        }
+
+        $locale = $result['LOCALE'];
+
+        return $breadcrumb;
+    }
+
+    public function getProductBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        $product = $this->getProduct();
+        $locale = null;
+
+        $breadcrumb = $this->getBaseBreadcrumb($router, $container, $product->getDefaultCategoryId(), $locale);
+
+        $product->setLocale($locale);
+
+        $breadcrumb[$product->getTitle()] = sprintf("%s?product_id=%d&current_tab=%s",
+            $router->generate('admin.products.update', [], Router::ABSOLUTE_URL),
+            $product->getId(),
+            $tab
+        );
+
+        return $breadcrumb;
+    }
+
+    public function getCategoryBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        $locale = null;
+        $category = $this->getCategory();
+        $breadcrumb = $this->getBaseBreadcrumb($router, $container, $this->getParentId(), $locale);
+
+        $category->setLocale($locale);
+
+        $breadcrumb[$category->getTitle()] = sprintf("%s?category_id=%d&current_tab=%s",
+            $router->generate('admin.categories.update',[], Router::ABSOLUTE_URL),
+            $category->getId(),
+            $tab
+        );
+
+        return $breadcrumb;
+    }
+}

core/lib/Thelia/Model/Breadcrumb/FolderBreadcrumbTrait.php

@@ -0,0 +1,84 @@
+<?php
+/*************************************************************************************/
+/*      This file is part of the Thelia package.                                     */
+/*                                                                                   */
+/*      Copyright (c) OpenStudio                                                     */
+/*      email : dev@thelia.net                                                       */
+/*      web : http://www.thelia.net                                                  */
+/*                                                                                   */
+/*      For the full copyright and license information, please view the LICENSE.txt  */
+/*      file that was distributed with this source code.                             */
+/*************************************************************************************/
+
+namespace Thelia\Model\Breadcrumb;
+
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
+use Thelia\Core\Template\Loop\FolderPath;
+use Thelia\Core\Translation\Translator;
+
+trait FolderBreadcrumbTrait {
+
+    public function getBaseBreadcrumb(Router $router, ContainerInterface $container, $folderId, &$locale)
+    {
+        $translator = Translator::getInstance();
+        $catalogUrl = $router->generate('admin.catalog', [], Router::ABSOLUTE_URL);
+        $breadcrumb = [
+            $translator->trans('Home', [], 'bo.default') => $router->generate('admin.home.view', [], Router::ABSOLUTE_URL),
+            $translator->trans('Folder', [], 'bo.default') => $catalogUrl,
+        ];
+
+        $folderPath = new FolderPath($container);
+        $folderPath->initializeArgs([
+                'folder' => $folderId,
+                'visible' => '*'
+            ]);
+
+        $results = $folderPath->buildArray();
+
+        foreach ($results as $result) {
+            $breadcrumb[$result['TITLE']] = sprintf("%s?folder_id=%d",
+                $router->generate('admin.folders.default',[], Router::ABSOLUTE_URL),
+                $result['ID']
+            );
+        }
+
+        $locale = $result['LOCALE'];
+
+        return $breadcrumb;
+    }
+
+    public function getFolderBreadcrumb($router, $container, $tab)
+    {
+        $locale = null;
+        $folder = $this->getFolder();
+        $breadcrumb = $this->getBaseBreadcrumb($router, $container, $this->getParentId(), $locale);
+
+        $folder->setLocale($locale);
+
+        $breadcrumb[$folder->getTitle()] = sprintf("%s?current_tab=%s",
+            $router->generate('admin.folders.update',['folder_id' => $folder->getId()], Router::ABSOLUTE_URL),
+            $tab
+        );
+
+        return $breadcrumb;
+    }
+
+    public function getContentBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        $content = $this->getContent();
+        $locale = null;
+
+        $breadcrumb = $this->getBaseBreadcrumb($router, $container, $content->getDefaultFolderId(), $locale);
+
+        $content->setLocale($locale);
+
+        $breadcrumb[$content->getTitle()] = sprintf("%s?current_tab=%s",
+            $router->generate('admin.content.update', ['content_id' => $content->getId()], Router::ABSOLUTE_URL),
+            $tab
+        );
+
+        return $breadcrumb;
+    }
+}

core/lib/Thelia/Model/CategoryDocument.php

@@ -2,13 +2,20 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
 use Thelia\Model\Base\CategoryDocument as BaseCategoryDocument;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\CatalogBreadcrumbTrait;
+use Thelia\Model\Tools\PositionManagementTrait;
+use Thelia\Model\Tools\ModelEventDispatcherTrait;
 
-class CategoryDocument extends BaseCategoryDocument
+class CategoryDocument extends BaseCategoryDocument implements BreadcrumbInterface
 {
-    use \Thelia\Model\Tools\ModelEventDispatcherTrait;
+    use ModelEventDispatcherTrait;
-    use \Thelia\Model\Tools\PositionManagementTrait;
+    use PositionManagementTrait;
+    use CatalogBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -62,4 +69,15 @@ class CategoryDocument extends BaseCategoryDocument
 
         return true;
     }
+
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getCategoryBreadcrumb($router, $container, $tab);
+    }
 }

core/lib/Thelia/Model/CategoryImage.php

@@ -2,13 +2,20 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
 use Thelia\Model\Base\CategoryImage as BaseCategoryImage;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\CatalogBreadcrumbTrait;
+use Thelia\Model\Tools\ModelEventDispatcherTrait;
+use Thelia\Model\Tools\PositionManagementTrait;
 
-class CategoryImage extends BaseCategoryImage
+class CategoryImage extends BaseCategoryImage implements BreadcrumbInterface
 {
-    use \Thelia\Model\Tools\ModelEventDispatcherTrait;
+    use ModelEventDispatcherTrait;
-    use \Thelia\Model\Tools\PositionManagementTrait;
+    use PositionManagementTrait;
+    use CatalogBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -62,4 +69,15 @@ class CategoryImage extends BaseCategoryImage
 
         return true;
     }
+
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getCategoryBreadcrumb($router, $container, $tab);
+    }
 }

core/lib/Thelia/Model/ContentDocument.php

@@ -2,13 +2,18 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
 use Thelia\Model\Base\ContentDocument as BaseContentDocument;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\FolderBreadcrumbTrait;
 
-class ContentDocument extends BaseContentDocument
+class ContentDocument extends BaseContentDocument implements BreadcrumbInterface
 {
     use \Thelia\Model\Tools\ModelEventDispatcherTrait;
     use \Thelia\Model\Tools\PositionManagementTrait;
+    use FolderBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -62,4 +67,15 @@ class ContentDocument extends BaseContentDocument
 
         return true;
     }
+
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getContentBreadcrumb($router, $container, $tab);
+    }
 }

core/lib/Thelia/Model/ContentImage.php

@@ -2,13 +2,18 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
 use Thelia\Model\Base\ContentImage as BaseContentImage;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\FolderBreadcrumbTrait;
 
-class ContentImage extends BaseContentImage
+class ContentImage extends BaseContentImage implements BreadcrumbInterface
 {
     use \Thelia\Model\Tools\ModelEventDispatcherTrait;
     use \Thelia\Model\Tools\PositionManagementTrait;
+    use FolderBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -62,4 +67,15 @@ class ContentImage extends BaseContentImage
 
         return true;
     }
+
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getContentBreadcrumb($router, $container, $tab);
+    }
 }

core/lib/Thelia/Model/FolderDocument.php

@@ -2,13 +2,18 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
 use Thelia\Model\Base\FolderDocument as BaseFolderDocument;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\FolderBreadcrumbTrait;
 
-class FolderDocument extends BaseFolderDocument
+class FolderDocument extends BaseFolderDocument implements BreadcrumbInterface
 {
     use \Thelia\Model\Tools\ModelEventDispatcherTrait;
     use \Thelia\Model\Tools\PositionManagementTrait;
+    use FolderBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -62,4 +67,9 @@ class FolderDocument extends BaseFolderDocument
 
         return true;
     }
+
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getFolderBreadcrumb($router, $container, $tab);
+    }
 }

core/lib/Thelia/Model/FolderImage.php

@@ -2,13 +2,18 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
 use Thelia\Model\Base\FolderImage as BaseFolderImage;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\FolderBreadcrumbTrait;
 
-class FolderImage extends BaseFolderImage
+class FolderImage extends BaseFolderImage implements BreadcrumbInterface
 {
     use \Thelia\Model\Tools\ModelEventDispatcherTrait;
     use \Thelia\Model\Tools\PositionManagementTrait;
+    use FolderBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -62,4 +67,15 @@ class FolderImage extends BaseFolderImage
 
         return true;
     }
+
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getFolderBreadcrumb($router, $container, $tab);
+    }
 }

core/lib/Thelia/Model/ProductDocument.php

@@ -2,13 +2,20 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
 use Thelia\Model\Base\ProductDocument as BaseProductDocument;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\CatalogBreadcrumbTrait;
+use Thelia\Model\Tools\PositionManagementTrait;
+use Thelia\Model\Tools\ModelEventDispatcherTrait;
 
-class ProductDocument extends BaseProductDocument
+class ProductDocument extends BaseProductDocument implements BreadcrumbInterface
 {
-    use \Thelia\Model\Tools\ModelEventDispatcherTrait;
+    use ModelEventDispatcherTrait;
-    use \Thelia\Model\Tools\PositionManagementTrait;
+    use PositionManagementTrait;
+    use CatalogBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -63,4 +70,14 @@ class ProductDocument extends BaseProductDocument
         return true;
     }
 
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getProductBreadcrumb($router, $container, $tab);
+    }
 }

core/lib/Thelia/Model/ProductImage.php

@@ -2,13 +2,23 @@
 
 namespace Thelia\Model;
 
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Routing\Router;
+use Thelia\Core\Template\Loop\CategoryPath;
+use Thelia\Core\Translation\Translator;
 use Thelia\Model\Base\ProductImage as BaseProductImage;
 use Propel\Runtime\Connection\ConnectionInterface;
+use Thelia\Model\Breadcrumb\BreadcrumbInterface;
+use Thelia\Model\Breadcrumb\CatalogBreadcrumbTrait;
+use Thelia\Model\Tools\ModelEventDispatcherTrait;
+use Thelia\Model\Tools\PositionManagementTrait;
+use Thelia\Tools\URL;
 
-class ProductImage extends BaseProductImage
+class ProductImage extends BaseProductImage implements BreadcrumbInterface
 {
-    use \Thelia\Model\Tools\ModelEventDispatcherTrait;
+    use ModelEventDispatcherTrait;
-    use \Thelia\Model\Tools\PositionManagementTrait;
+    use PositionManagementTrait;
+    use CatalogBreadcrumbTrait;
 
     /**
      * Calculate next position relative to our parent
@@ -62,4 +72,15 @@ class ProductImage extends BaseProductImage
 
         return true;
     }
+
+    /**
+     *
+     * return the complete breadcrumb for a given resource.
+     *
+     * @return array
+     */
+    public function getBreadcrumb(Router $router, ContainerInterface $container, $tab)
+    {
+        return $this->getProductBreadcrumb($router, $container, $tab);
+    }
 }

templates/backOffice/default/document-edit.html

@@ -11,8 +11,9 @@
 
             {loop type="document" name="document_edit" source="{$documentType}" id="{$documentId}" backend_context="1" lang="$edit_language_id"}
                 <ul class="breadcrumb">
-        			<li><a href="{url path='/admin/home'}">{intl l="Home"}</a></li>
+                    {foreach $breadcrumb as $label=>$link}
-                    <li><a href="{url path="{$redirectUrl}"}">{intl l="Document"}</a></li>
+                        <li><a href="{$link}">{$label}</a></li>
+                    {/foreach}
                     <li>{intl l='Editing document "%name"' name="{$TITLE}"}</li>
                 </ul>
 

templates/backOffice/default/image-edit.html

@@ -11,8 +11,9 @@
 
             {loop type="image" name="image_edit" source="{$imageType}" id="{$imageId}" width="580" backend_context="1" lang="$edit_language_id"}
                 <ul class="breadcrumb">
-        			<li><a href="{url path='/admin/home'}">{intl l="Home"}</a></li>
+                    {foreach $breadcrumb as $label=>$link}
-                    <li><a href="{url path="{$redirectUrl}"}">{intl l="Image"}</a></li>
+                    <li><a href="{$link}">{$label}</a></li>
+                    {/foreach}
                     <li>{intl l='Editing image "%name"' name={$TITLE}}</li>
                 </ul>