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

  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.      * @param mixed $data
  48.      *
  49.      * @return $this
  50.      */
  51.     public function setDataFromEditmode(mixed $data): static
  52.     {
  53.         // IMPORTANT: if you use this method be sure that the type of the property is already set
  55.         if (in_array($this->getType(), ['document', 'asset', 'object'])) {
  56.             $el = Element\Service::getElementByPath($this->getType(), (string)$data);
  57.             $this->data = null;
  58.             if ($el) {
  59.                 $this->data = $el->getId();
  60.             }
  61.         } elseif ($this->type == 'bool') {
  62.             $this->data = false;
  63.             if (!empty($data)) {
  64.                 $this->data = true;
  65.             }
  66.         } else {
  67.             // plain text
  68.             $this->data = $data;
  69.         }
  71.         return $this;
  72.     }
  74.     /**
  75.      * @internal
  76.      *
  77.      * @param mixed $data
  78.      *
  79.      * @return $this
  80.      */
  81.     public function setDataFromResource(mixed $data): static
  82.     {
  83.         // IMPORTANT: if you use this method be sure that the type of the property is already set
  84.         // do not set data for object, asset and document here, this is loaded dynamically when calling $this->getData();
  85.         if ($this->type == 'date') {
  86.             $this->data = \Pimcore\Tool\Serialize::unserialize($data);
  87.         } elseif ($this->type == 'bool') {
  88.             $this->data = false;
  89.             if (!empty($data)) {
  90.                 $this->data = true;
  91.             }
  92.         } else {
  93.             // plain text
  94.             $this->data = $data;
  95.         }
  97.         return $this;
  98.     }
  100.     public function getCid(): ?int
  101.     {
  102.         return $this->cid;
  103.     }
  105.     /**
  106.      * enum('document','asset','object')
  107.      */
  108.     public function getCtype(): ?string
  109.     {
  110.         return $this->ctype;
  111.     }
  113.     public function getData(): mixed
  114.     {
  115.         // lazy-load data of type asset, document, object
  116.         if (in_array($this->getType(), ['document', 'asset', 'object']) && !$this->data instanceof ElementInterface && is_numeric($this->data)) {
  117.             return Element\Service::getElementById($this->getType(), (int) $this->data);
  118.         }
  120.         return $this->data;
  121.     }
  123.     public function getName(): ?string
  124.     {
  125.         return $this->name;
  126.     }
  128.     /**
  129.      * enum('text','document','asset','object','bool','select')
  130.      */
  131.     public function getType(): ?string
  132.     {
  133.         return $this->type;
  134.     }
  136.     /**
  137.      * @return $this
  138.      */
  139.     public function setCid(int $cid): static
  140.     {
  141.         $this->cid = $cid;
  143.         return $this;
  144.     }
  146.     /**
  147.      * enum('document','asset','object')
  148.      *
  149.      * @param string $ctype
  150.      *
  151.      * @return $this
  152.      */
  153.     public function setCtype(string $ctype): static
  154.     {
  155.         $this->ctype = $ctype;
  157.         return $this;
  158.     }
  160.     /**
  161.      * @return $this
  162.      */
  163.     public function setData(mixed $data): static
  164.     {
  165.         if ($data instanceof ElementInterface) {
  166.             $this->setType(Service::getElementType($data));
  167.             $data = $data->getId();
  168.         }
  170.         $this->data = $data;
  172.         return $this;
  173.     }
  175.     /**
  176.      * @return $this
  177.      */
  178.     public function setName(string $name): static
  179.     {
  180.         $this->name = $name;
  182.         return $this;
  183.     }
  185.     /**
  186.      * enum('text','document','asset','object','bool','select')
  187.      *
  188.      * @param string $type
  189.      *
  190.      * @return $this
  191.      */
  192.     public function setType(string $type): static
  193.     {
  194.         $this->type = $type;
  196.         return $this;
  197.     }
  199.     public function getCpath(): ?string
  200.     {
  201.         return $this->cpath;
  202.     }
  204.     public function getInherited(): bool
  205.     {
  206.         return $this->inherited;
  207.     }
  209.     /**
  210.      * Alias for getInherited()
  211.      *
  212.      * @return bool
  213.      */
  214.     public function isInherited(): bool
  215.     {
  216.         return $this->getInherited();
  217.     }
  219.     /**
  220.      * @return $this
  221.      */
  222.     public function setCpath(?string $cpath): static
  223.     {
  224.         $this->cpath = $cpath;
  226.         return $this;
  227.     }
  229.     /**
  230.      * @return $this
  231.      */
  232.     public function setInherited(bool $inherited): static
  233.     {
  234.         $this->inherited = $inherited;
  236.         return $this;
  237.     }
  239.     public function getInheritable(): bool
  240.     {
  241.         return $this->inheritable;
  242.     }
  244.     /**
  245.      * @return $this
  246.      */
  247.     public function setInheritable(bool $inheritable): static
  248.     {
  249.         $this->inheritable = $inheritable;
  251.         return $this;
  252.     }
  254.     /**
  255.      * @internal
  256.      *
  257.      * @return array
  258.      */
  259.     public function resolveDependencies(): array
  260.     {
  261.         $dependencies = [];
  263.         if ($this->getData() instanceof ElementInterface) {
  264.             $elementType = Element\Service::getElementType($this->getData());
  265.             $key = $elementType . '_' . $this->getData()->getId();
  266.             $dependencies[$key] = [
  267.                 'id' => $this->getData()->getId(),
  268.                 'type' => $elementType,
  269.             ];
  270.         }
  272.         return $dependencies;
  273.     }
  275.     /**
  276.      * Rewrites id from source to target, $idMapping contains
  277.      * array(
  278.      *  "document" => array(
  279.      *      SOURCE_ID => TARGET_ID,
  280.      *      SOURCE_ID => TARGET_ID
  281.      *  ),
  282.      *  "object" => array(...),
  283.      *  "asset" => array(...)
  284.      * )
  285.      *
  286.      * @param array $idMapping
  287.      *
  288.      * @internal
  289.      */
  290.     public function rewriteIds(array $idMapping): void
  291.     {
  292.         if (!$this->isInherited()) {
  293.             if (array_key_exists($this->getType(), $idMapping)) {
  294.                 if ($this->getData() instanceof ElementInterface) {
  295.                     if (array_key_exists((int) $this->getData()->getId(), $idMapping[$this->getType()])) {
  296.                         $this->setData(Element\Service::getElementById($this->getType(), $idMapping[$this->getType()][$this->getData()->getId()]));
  297.                     }
  298.                 }
  299.             }
  300.         }
  301.     }
  303.     /**
  304.      * @internal
  305.      *
  306.      * @return array
  307.      */
  308.     public function serialize(): array
  309.     {
  310.         return [
  311.           'name' => $this->getName(),
  312.           'type' => $this->getType(),
  313.           'data' => $this->getData(),
  314.         ];
  315.     }
  316. }