vendor/pimcore/pimcore/lib/Routing/DocumentRoute.php line 21

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Routing;
  17. use Pimcore\Model\Document;
  18. use Symfony\Cmf\Component\Routing\RouteObjectInterface;
  19. use Symfony\Component\Routing\Route;
  21. class DocumentRoute extends Route implements RouteObjectInterface
  22. {
  23.     /**
  24.      * @var Document
  25.      */
  26.     protected $document;
  28.     /**
  29.      * @return Document
  30.      */
  31.     public function getDocument()
  32.     {
  33.         return $this->document;
  34.     }
  36.     /**
  37.      * @param Document $document
  38.      *
  39.      * @return $this
  40.      */
  41.     public function setDocument($document)
  42.     {
  43.         $this->document = $document;
  45.         return $this;
  46.     }
  48.     /**
  49.      * Get the content document this route entry stands for. If non-null,
  50.      * the ControllerClassMapper uses it to identify a controller and
  51.      * the content is passed to the controller.
  52.      *
  53.      * If there is no specific content for this url (i.e. its an "application"
  54.      * page), may return null.
  55.      *
  56.      * @return object the document or entity this route entry points to
  57.      */
  58.     public function getContent()
  59.     {
  60.         return $this->getDocument();
  61.     }
  63.     /**
  64.      * Get the route name.
  65.      *
  66.      * Normal symfony routes do not know their name, the name is only known
  67.      * from the route collection. In the CMF, it is possible to use route
  68.      * documents outside of collections, and thus useful to have routes provide
  69.      * their name.
  70.      *
  71.      * There are no limitations to allowed characters in the name.
  72.      *
  73.      * @return string|null the route name or null to use the default name
  74.      *                     (e.g. from route collection if known)
  75.      */
  76.     public function getRouteKey()
  77.     {
  78.         if ($this->document) {
  79.             return sprintf('document_%d', $this->document->getId());
  80.         }
  81.     }
  82. }