vendor/pimcore/pimcore/models/Tool/SettingsStore.php line 128

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\Tool;
  18. use Pimcore\Model;
  19. use Pimcore\Model\Tool\SettingsStore\Dao;
  21. /**
  22.  * @method Dao getDao()
  23.  */
  24. final class SettingsStore extends Model\AbstractModel
  25. {
  26.     protected static $allowedTypes = ['bool', 'int', 'float', 'string'];
  28.     /**
  29.      * @internal
  30.      *
  31.      * @var string
  32.      */
  33.     protected $id;
  35.     /**
  36.      * @internal
  37.      *
  38.      * @var string|null
  39.      */
  40.     protected $scope;
  42.     /**
  43.      * @internal
  44.      *
  45.      * @var string
  46.      */
  47.     protected $type;
  49.     /**
  50.      * @internal
  51.      *
  52.      * @var mixed
  53.      */
  54.     protected $data;
  56.     /**
  57.      * @internal
  58.      *
  59.      * @var self|null
  60.      */
  61.     protected static ?self $instance = null;
  63.     /**
  64.      * @return self
  65.      */
  66.     private static function getInstance(): self
  67.     {
  68.         if (!self::$instance) {
  69.             self::$instance = new self();
  70.         }
  72.         return self::$instance;
  73.     }
  75.     /**
  76.      * @param string $type
  77.      *
  78.      * @return bool
  79.      *
  80.      * @throws \Exception
  81.      */
  82.     private static function validateType(string $type): bool
  83.     {
  84.         if (!in_array($type, self::$allowedTypes)) {
  85.             throw new \Exception(sprintf('Invalid type `%s`, allowed types are %s', $type, implode(',', self::$allowedTypes)));
  86.         }
  88.         return true;
  89.     }
  91.     /**
  92.      * @param string $id
  93.      * @param int|string|bool|float $data
  94.      * @param string $type
  95.      * @param string|null $scope
  96.      *
  97.      * @return bool
  98.      *
  99.      * @throws \Exception
  100.      */
  101.     public static function set(string $id, $data, string $type = 'string', ?string $scope = null): bool
  102.     {
  103.         self::validateType($type);
  104.         $instance = self::getInstance();
  106.         return $instance->getDao()->set($id, $data, $type, $scope);
  107.     }
  109.     /**
  110.      * @param string $id
  111.      * @param string|null $scope
  112.      *
  113.      * @return mixed
  114.      */
  115.     public static function delete(string $id, ?string $scope = null)
  116.     {
  117.         $instance = self::getInstance();
  119.         return $instance->getDao()->delete($id, $scope);
  120.     }
  122.     /**
  123.      * @param string $id
  124.      * @param string|null $scope
  125.      *
  126.      * @return SettingsStore|null
  127.      */
  128.     public static function get(string $id, ?string $scope = null): ?SettingsStore
  129.     {
  130.         $item = new self();
  131.         if ($item->getDao()->getById($id, $scope)) {
  132.             return $item;
  133.         }
  135.         return null;
  136.     }
  138.     /**
  139.      * @param string $scope
  140.      *
  141.      * @return string[]
  142.      */
  143.     public static function getIdsByScope(string $scope): array
  144.     {
  145.         $instance = self::getInstance();
  147.         return $instance->getDao()->getIdsByScope($scope);
  148.     }
  150.     /**
  151.      * @return string
  152.      */
  153.     public function getId(): string
  154.     {
  155.         return $this->id;
  156.     }
  158.     /**
  159.      * @param string $id
  160.      */
  161.     public function setId(string $id): void
  162.     {
  163.         $this->id = $id;
  164.     }
  166.     /**
  167.      * @return string|null
  168.      */
  169.     public function getScope(): ?string
  170.     {
  171.         return $this->scope;
  172.     }
  174.     /**
  175.      * @param string|null $scope
  176.      */
  177.     public function setScope(?string $scope): void
  178.     {
  179.         $this->scope = (string) $scope;
  180.     }
  182.     /**
  183.      * @return string|null
  184.      */
  185.     public function getType(): ?string
  186.     {
  187.         return $this->type;
  188.     }
  190.     /**
  191.      * @param string $type
  192.      *
  193.      * @throws \Exception
  194.      */
  195.     public function setType(string $type): void
  196.     {
  197.         self::validateType($type);
  198.         $this->type = $type;
  199.     }
  201.     /**
  202.      * @return int|string|bool|float
  203.      */
  204.     public function getData()
  205.     {
  206.         return $this->data;
  207.     }
  209.     /**
  210.      * @param int|string|bool|float $data
  211.      */
  212.     public function setData($data): void
  213.     {
  214.         if (!empty($this->getType())) {
  215.             settype($data, $this->getType());
  216.         }
  217.         $this->data = $data;
  218.     }
  219. }