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

  1. <?php
  2. declare(strict_types=1);
  4. /**
  5.  * Pimcore
  6.  *
  7.  * This source file is available under two different licenses:
  8.  * - GNU General Public License version 3 (GPLv3)
  9.  * - Pimcore Commercial License (PCL)
  10.  * Full copyright and license information is available in
  11.  * LICENSE.md which is distributed with this source code.
  12.  *
  13.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  14.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  15.  */
  17. namespace Pimcore\Model\Document\Editable\Area;
  19. use Pimcore\Model\Document;
  20. use Pimcore\Model\Document\Editable;
  21. use Symfony\Component\HttpFoundation\Request;
  23. class Info
  24. {
  25.     /**
  26.      * @internal
  27.      *
  28.      */
  29.     protected ?string $id = null;
  31.     /**
  32.      * @internal
  33.      *
  34.      */
  35.     protected ?Editable $editable = null;
  37.     /**
  38.      * @internal
  39.      *
  40.      */
  41.     protected array $params = [];
  43.     /**
  44.      * @internal
  45.      *
  46.      */
  47.     protected ?Request $request = null;
  49.     /**
  50.      * @internal
  51.      *
  52.      */
  53.     protected ?string $type = null;
  55.     /**
  56.      * @internal
  57.      *
  58.      */
  59.     protected ?int $index = null;
  61.     public function getId(): ?string
  62.     {
  63.         return $this->id;
  64.     }
  66.     public function setId(?string $id): static
  67.     {
  68.         $this->id = $id;
  70.         return $this;
  71.     }
  73.     public function getEditable(): ?Editable
  74.     {
  75.         return $this->editable;
  76.     }
  78.     public function setEditable(Editable $editable): void
  79.     {
  80.         $this->editable = $editable;
  81.     }
  83.     public function getType(): ?string
  84.     {
  85.         return $this->type;
  86.     }
  88.     public function setType(?string $type): static
  89.     {
  90.         $this->type = $type;
  92.         return $this;
  93.     }
  95.     public function getParams(): array
  96.     {
  97.         return $this->params;
  98.     }
  100.     public function getParam(string $name): mixed
  101.     {
  102.         if (isset($this->params[$name])) {
  103.             return $this->params[$name];
  104.         }
  106.         return null;
  107.     }
  109.     public function setParam(string $name, mixed $value): static
  110.     {
  111.         $this->params[$name] = $value;
  113.         return $this;
  114.     }
  116.     public function setParams(array $params): static
  117.     {
  118.         $this->params = $params;
  120.         return $this;
  121.     }
  123.     public function getRequest(): ?Request
  124.     {
  125.         return $this->request;
  126.     }
  128.     public function setRequest(Request $request): static
  129.     {
  130.         $this->request = $request;
  132.         return $this;
  133.     }
  135.     public function setIndex(?int $index): static
  136.     {
  137.         $this->index = $index;
  139.         return $this;
  140.     }
  142.     public function getIndex(): ?int
  143.     {
  144.         return $this->index;
  145.     }
  147.     public function getDocument(): Document\PageSnippet
  148.     {
  149.         return $this->editable->getDocument();
  150.     }
  152.     /**
  153.      *
  154.      *
  155.      * @throws \Exception
  156.      */
  157.     public function getDocumentElement(string $name, string $type = ''): ?Editable
  158.     {
  159.         $editable = null;
  160.         $document = $this->getDocument();
  162.         if ($document instanceof Document\PageSnippet) {
  163.             $name = Editable::buildEditableName($type, $name, $document);
  164.             $editable = $document->getEditable($name);
  165.         }
  167.         return $editable;
  168.     }
  169. }