vendor/pimcore/pimcore/models/Property.php line 25

  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;
  19. use Pimcore\Model\Element\ElementInterface;
  20. use Pimcore\Model\Element\Service;
  22. /**
  23.  * @method \Pimcore\Model\Property\Dao getDao()
  24.  * @method void save()
  25.  */
  26. final class Property extends AbstractModel
  27. {
  28.     protected ?string $name = null;
  30.     protected mixed $data = null;
  32.     protected ?string $type = null;
  34.     protected ?string $ctype = null;
  36.     protected ?string $cpath = null;
  38.     protected ?int $cid = null;
  40.     protected bool $inheritable = false;
  42.     protected bool $inherited = false;
  44.     /**
  45.      * @internal
  46.      *
  47.      * @return $this
  48.      */
  49.     public function setDataFromEditmode(mixed $data): static
  50.     {
  51.         // IMPORTANT: if you use this method be sure that the type of the property is already set
  53.         if (in_array($this->getType(), ['document', 'asset', 'object'])) {
  54.             $el = Element\Service::getElementByPath($this->getType(), (string)$data);
  55.             $this->data = null;
  56.             if ($el) {
  57.                 $this->data = $el->getId();
  58.             }
  59.         } elseif ($this->type == 'bool') {
  60.             $this->data = false;
  61.             if (!empty($data)) {
  62.                 $this->data = true;
  63.             }
  64.         } else {
  65.             // plain text
  66.             $this->data = $data;
  67.         }
  69.         return $this;
  70.     }
  72.     /**
  73.      * @internal
  74.      *
  75.      * @return $this
  76.      */
  77.     public function setDataFromResource(mixed $data): static
  78.     {
  79.         // IMPORTANT: if you use this method be sure that the type of the property is already set
  80.         // do not set data for object, asset and document here, this is loaded dynamically when calling $this->getData();
  81.         if ($this->type == 'date') {
  82.             $this->data = \Pimcore\Tool\Serialize::unserialize($data);
  83.         } elseif ($this->type == 'bool') {
  84.             $this->data = false;
  85.             if (!empty($data)) {
  86.                 $this->data = true;
  87.             }
  88.         } else {
  89.             // plain text
  90.             $this->data = $data;
  91.         }
  93.         return $this;
  94.     }
  96.     public function getCid(): ?int
  97.     {
  98.         return $this->cid;
  99.     }
  101.     /**
  102.      * enum('document','asset','object')
  103.      */
  104.     public function getCtype(): ?string
  105.     {
  106.         return $this->ctype;
  107.     }
  109.     public function getData(): mixed
  110.     {
  111.         // lazy-load data of type asset, document, object
  112.         if (in_array($this->getType(), ['document', 'asset', 'object']) && !$this->data instanceof ElementInterface && is_numeric($this->data)) {
  113.             return Element\Service::getElementById($this->getType(), (int) $this->data);
  114.         }
  116.         return $this->data;
  117.     }
  119.     public function getName(): ?string
  120.     {
  121.         return $this->name;
  122.     }
  124.     /**
  125.      * enum('text','document','asset','object','bool','select')
  126.      */
  127.     public function getType(): ?string
  128.     {
  129.         return $this->type;
  130.     }
  132.     /**
  133.      * @return $this
  134.      */
  135.     public function setCid(int $cid): static
  136.     {
  137.         $this->cid = $cid;
  139.         return $this;
  140.     }
  142.     /**
  143.      * enum('document','asset','object')
  144.      *
  145.      *
  146.      * @return $this
  147.      */
  148.     public function setCtype(string $ctype): static
  149.     {
  150.         $this->ctype = $ctype;
  152.         return $this;
  153.     }
  155.     /**
  156.      * @return $this
  157.      */
  158.     public function setData(mixed $data): static
  159.     {
  160.         if ($data instanceof ElementInterface) {
  161.             $this->setType(Service::getElementType($data));
  162.             $data = $data->getId();
  163.         }
  165.         $this->data = $data;
  167.         return $this;
  168.     }
  170.     /**
  171.      * @return $this
  172.      */
  173.     public function setName(string $name): static
  174.     {
  175.         $this->name = $name;
  177.         return $this;
  178.     }
  180.     /**
  181.      * enum('text','document','asset','object','bool','select')
  182.      *
  183.      *
  184.      * @return $this
  185.      */
  186.     public function setType(string $type): static
  187.     {
  188.         $this->type = $type;
  190.         return $this;
  191.     }
  193.     public function getCpath(): ?string
  194.     {
  195.         return $this->cpath;
  196.     }
  198.     public function getInherited(): bool
  199.     {
  200.         return $this->inherited;
  201.     }
  203.     /**
  204.      * Alias for getInherited()
  205.      *
  206.      */
  207.     public function isInherited(): bool
  208.     {
  209.         return $this->getInherited();
  210.     }
  212.     /**
  213.      * @return $this
  214.      */
  215.     public function setCpath(?string $cpath): static
  216.     {
  217.         $this->cpath = $cpath;
  219.         return $this;
  220.     }
  222.     /**
  223.      * @return $this
  224.      */
  225.     public function setInherited(bool $inherited): static
  226.     {
  227.         $this->inherited = $inherited;
  229.         return $this;
  230.     }
  232.     public function getInheritable(): bool
  233.     {
  234.         return $this->inheritable;
  235.     }
  237.     /**
  238.      * @return $this
  239.      */
  240.     public function setInheritable(bool $inheritable): static
  241.     {
  242.         $this->inheritable = $inheritable;
  244.         return $this;
  245.     }
  247.     /**
  248.      * @internal
  249.      *
  250.      */
  251.     public function resolveDependencies(): array
  252.     {
  253.         $dependencies = [];
  255.         if ($this->getData() instanceof ElementInterface) {
  256.             $elementType = Element\Service::getElementType($this->getData());
  257.             $key = $elementType . '_' . $this->getData()->getId();
  258.             $dependencies[$key] = [
  259.                 'id' => $this->getData()->getId(),
  260.                 'type' => $elementType,
  261.             ];
  262.         }
  264.         return $dependencies;
  265.     }
  267.     /**
  268.      * Rewrites id from source to target, $idMapping contains
  269.      * array(
  270.      *  "document" => array(
  271.      *      SOURCE_ID => TARGET_ID,
  272.      *      SOURCE_ID => TARGET_ID
  273.      *  ),
  274.      *  "object" => array(...),
  275.      *  "asset" => array(...)
  276.      * )
  277.      *
  278.      *
  279.      * @internal
  280.      */
  281.     public function rewriteIds(array $idMapping): void
  282.     {
  283.         if (!$this->isInherited()) {
  284.             if (array_key_exists($this->getType(), $idMapping)) {
  285.                 if ($this->getData() instanceof ElementInterface) {
  286.                     if (array_key_exists((int) $this->getData()->getId(), $idMapping[$this->getType()])) {
  287.                         $this->setData(Element\Service::getElementById($this->getType(), $idMapping[$this->getType()][$this->getData()->getId()]));
  288.                     }
  289.                 }
  290.             }
  291.         }
  292.     }
  294.     /**
  295.      * @internal
  296.      *
  297.      */
  298.     public function serialize(): array
  299.     {
  300.         return [
  301.           'name' => $this->getName(),
  302.           'type' => $this->getType(),
  303.           'data' => $this->getData(),
  304.         ];
  305.     }
  306. }