vendor/pimcore/pimcore/models/Document/Editable/Area/Info.php line 22

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\Model\Document\Editable\Area;
  18. use Pimcore\Model\Document;
  19. use Pimcore\Model\Document\Editable;
  20. use Symfony\Component\HttpFoundation\Request;
  22. class Info
  23. {
  24.     /**
  25.      * @internal
  26.      *
  27.      * @var string|null
  28.      */
  29.     protected $id;
  31.     /**
  32.      * @internal
  33.      *
  34.      * @var Editable|null
  35.      */
  36.     protected $editable;
  38.     /**
  39.      * @internal
  40.      *
  41.      * @var array
  42.      */
  43.     protected $params = [];
  45.     /**
  46.      * @internal
  47.      *
  48.      * @var Request|null
  49.      */
  50.     protected $request;
  52.     /**
  53.      * @internal
  54.      *
  55.      * @var string|null
  56.      */
  57.     protected $type;
  59.     /**
  60.      * @internal
  61.      *
  62.      * @var int|null
  63.      */
  64.     protected $index;
  66.     /**
  67.      * @return string|null
  68.      */
  69.     public function getId()
  70.     {
  71.         return $this->id;
  72.     }
  74.     /**
  75.      * @param string|null $id
  76.      *
  77.      * @return $this
  78.      */
  79.     public function setId($id)
  80.     {
  81.         $this->id = $id;
  83.         return $this;
  84.     }
  86.     /**
  87.      * @return Editable|null
  88.      */
  89.     public function getEditable()
  90.     {
  91.         return $this->editable;
  92.     }
  94.     /**
  95.      * @param Editable $editable
  96.      */
  97.     public function setEditable(Editable $editable)
  98.     {
  99.         $this->editable = $editable;
  100.     }
  102.     /**
  103.      * @return string|null
  104.      */
  105.     public function getType()
  106.     {
  107.         return $this->type;
  108.     }
  110.     /**
  111.      * @param string|null $type
  112.      *
  113.      * @return $this
  114.      */
  115.     public function setType($type)
  116.     {
  117.         $this->type = $type;
  119.         return $this;
  120.     }
  122.     /**
  123.      * @return array
  124.      */
  125.     public function getParams()
  126.     {
  127.         return $this->params;
  128.     }
  130.     /**
  131.      * @param string $name
  132.      *
  133.      * @return mixed
  134.      */
  135.     public function getParam(string $name)
  136.     {
  137.         if (isset($this->params[$name])) {
  138.             return $this->params[$name];
  139.         }
  141.         return null;
  142.     }
  144.     /**
  145.      * @param string $name
  146.      * @param mixed $value
  147.      *
  148.      * @return $this
  149.      */
  150.     public function setParam(string $name, $value)
  151.     {
  152.         $this->params[$name] = $value;
  154.         return $this;
  155.     }
  157.     /**
  158.      * @param array $params
  159.      *
  160.      * @return $this
  161.      */
  162.     public function setParams(array $params)
  163.     {
  164.         $this->params = $params;
  166.         return $this;
  167.     }
  169.     /**
  170.      * @return Request|null
  171.      */
  172.     public function getRequest()
  173.     {
  174.         return $this->request;
  175.     }
  177.     /**
  178.      * @param Request $request
  179.      *
  180.      * @return $this
  181.      */
  182.     public function setRequest(Request $request)
  183.     {
  184.         $this->request = $request;
  186.         return $this;
  187.     }
  189.     /**
  190.      * @param int|null $index
  191.      *
  192.      * @return $this
  193.      */
  194.     public function setIndex($index)
  195.     {
  196.         $this->index = $index;
  198.         return $this;
  199.     }
  201.     /**
  202.      * @return int|null
  203.      */
  204.     public function getIndex()
  205.     {
  206.         return $this->index;
  207.     }
  209.     /**
  210.      * @return Document\PageSnippet
  211.      */
  212.     public function getDocument()
  213.     {
  214.         return $this->editable->getDocument();
  215.     }
  217.     /**
  218.      * @param string $name
  219.      * @param string $type
  220.      *
  221.      * @return Editable|null
  222.      *
  223.      * @throws \Exception
  224.      */
  225.     public function getDocumentElement($name, $type = '')
  226.     {
  227.         $editable = null;
  228.         $document = $this->getDocument();
  230.         if ($document instanceof Document\PageSnippet) {
  231.             $name = Editable::buildEditableName($type, $name, $document);
  232.             $editable = $document->getEditable($name);
  233.         }
  235.         return $editable;
  236.     }
  237. }