vendor/pimcore/pimcore/lib/Navigation/Page/Document.php line 138

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Navigation\Page;
  18. use Pimcore\Model;
  20. class Document extends Url
  21. {
  22.     /**
  23.      * @var string|null
  24.      */
  25.     protected ?string $_accesskey = null;
  27.     /**
  28.      * @var string|null
  29.      */
  30.     protected ?string $_tabindex = null;
  32.     /**
  33.      * @var string|null
  34.      */
  35.     protected ?string $_relation = null;
  37.     /**
  38.      * @var int
  39.      */
  40.     protected $_documentId;
  42.     /**
  43.      * @var string
  44.      */
  45.     protected $documentType;
  47.     /**
  48.      * @var string
  49.      */
  50.     protected $realFullPath;
  52.     /**
  53.      * @var array
  54.      */
  55.     protected $customSettings = [];
  57.     /**
  58.      * @param string $tabindex
  59.      *
  60.      * @return $this
  61.      */
  62.     public function setTabindex($tabindex)
  63.     {
  64.         $this->_tabindex = $tabindex;
  66.         return $this;
  67.     }
  69.     /**
  70.      * @return string
  71.      */
  72.     public function getTabindex()
  73.     {
  74.         return $this->_tabindex;
  75.     }
  77.     /**
  78.      * @param string|null $character
  79.      *
  80.      * @return $this
  81.      */
  82.     public function setAccesskey(?string $character = null)
  83.     {
  84.         $this->_accesskey = $character;
  86.         return $this;
  87.     }
  89.     /**
  90.      * @return string|null
  91.      */
  92.     public function getAccesskey(): ?string
  93.     {
  94.         return $this->_accesskey;
  95.     }
  97.     /**
  98.      * @param string $relation
  99.      *
  100.      * @return $this
  101.      */
  102.     public function setRelation($relation)
  103.     {
  104.         $this->_relation = $relation;
  106.         return $this;
  107.     }
  109.     /**
  110.      * @return string
  111.      */
  112.     public function getRelation()
  113.     {
  114.         return $this->_relation;
  115.     }
  117.     /**
  118.      * @param Model\Document $document
  119.      *
  120.      * @return $this
  121.      */
  122.     public function setDocument($document)
  123.     {
  124.         $this->setDocumentId($document->getId());
  125.         $this->setDocumentType($document->getType());
  126.         $this->setRealFullPath($document->getRealFullPath());
  128.         return $this;
  129.     }
  131.     /**
  132.      * @return Model\Document|null
  133.      */
  134.     public function getDocument()
  135.     {
  136.         $docId = $this->getDocumentId();
  137.         if ($docId) {
  138.             $doc = Model\Document::getById($docId);
  139.             if ($doc instanceof Model\Document\Hardlink) {
  140.                 $doc = Model\Document\Hardlink\Service::wrap($doc);
  141.             }
  143.             return $doc;
  144.         }
  146.         return null;
  147.     }
  149.     /**
  150.      * @return int
  151.      */
  152.     public function getDocumentId()
  153.     {
  154.         return $this->_documentId;
  155.     }
  157.     /**
  158.      * @param int $documentId
  159.      */
  160.     public function setDocumentId($documentId)
  161.     {
  162.         $this->_documentId = $documentId;
  163.     }
  165.     /**
  166.      * @return string
  167.      */
  168.     public function getDocumentType()
  169.     {
  170.         return $this->documentType;
  171.     }
  173.     /**
  174.      * @param string $documentType
  175.      */
  176.     public function setDocumentType($documentType)
  177.     {
  178.         $this->documentType = $documentType;
  179.     }
  181.     /**
  182.      * @return string
  183.      */
  184.     public function getRealFullPath()
  185.     {
  186.         return $this->realFullPath;
  187.     }
  189.     /**
  190.      * @param string $realFullPath
  191.      */
  192.     public function setRealFullPath($realFullPath)
  193.     {
  194.         $this->realFullPath = $realFullPath;
  195.     }
  197.     /**
  198.      * @param string $name
  199.      * @param mixed $value
  200.      *
  201.      * @return $this
  202.      */
  203.     public function setCustomSetting($name, $value)
  204.     {
  205.         $this->customSettings[$name] = $value;
  207.         return $this;
  208.     }
  210.     /**
  211.      * @param string $name
  212.      *
  213.      * @return mixed
  214.      */
  215.     public function getCustomSetting($name)
  216.     {
  217.         if (array_key_exists($name, $this->customSettings)) {
  218.             return $this->customSettings[$name];
  219.         }
  221.         return null;
  222.     }
  223. }