vendor/pimcore/pimcore/models/Tool/TmpStore.php line 115

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;
  20. /**
  21.  * @method bool getById(string $id)
  22.  * @method \Pimcore\Model\Tool\TmpStore\Dao getDao()
  23.  */
  24. final class TmpStore extends Model\AbstractModel
  25. {
  26.     /**
  27.      * @internal
  28.      *
  29.      * @var string
  30.      */
  31.     protected $id;
  33.     /**
  34.      * @internal
  35.      *
  36.      * @var string
  37.      */
  38.     protected $tag;
  40.     /**
  41.      * @internal
  42.      *
  43.      * @var mixed
  44.      */
  45.     protected $data;
  47.     /**
  48.      * @internal
  49.      *
  50.      * @var int
  51.      */
  52.     protected $date;
  54.     /**
  55.      * @internal
  56.      *
  57.      * @var int
  58.      */
  59.     protected $expiryDate;
  61.     /**
  62.      * @internal
  63.      *
  64.      * @var bool
  65.      */
  66.     protected $serialized = false;
  68.     /**
  69.      * @internal
  70.      *
  71.      * @var self|null
  72.      */
  73.     protected static ?self $instance = null;
  75.     /**
  76.      * @return self
  77.      */
  78.     private static function getInstance(): self
  79.     {
  80.         if (!self::$instance) {
  81.             self::$instance = new self();
  82.         }
  84.         return self::$instance;
  85.     }
  87.     /**
  88.      * @return int
  89.      */
  90.     private static function getDefaultLifetime()
  91.     {
  92.         return 86400 * 7;
  93.     }
  95.     /**
  96.      * @param string $id
  97.      * @param mixed $data
  98.      * @param string|null $tag
  99.      * @param int|null $lifetime
  100.      *
  101.      * @return bool
  102.      */
  103.     public static function add($id, $data, $tag = null, $lifetime = null)
  104.     {
  105.         $instance = self::getInstance();
  107.         if (!$lifetime) {
  108.             $lifetime = self::getDefaultLifetime();
  109.         }
  111.         if (self::get($id)) {
  112.             return true;
  113.         }
  115.         return $instance->getDao()->add($id, $data, $tag, $lifetime);
  116.     }
  118.     /**
  119.      * @param string $id
  120.      * @param mixed $data
  121.      * @param string|null $tag
  122.      * @param int|null $lifetime
  123.      *
  124.      * @return bool
  125.      */
  126.     public static function set($id, $data, $tag = null, $lifetime = null)
  127.     {
  128.         $instance = self::getInstance();
  130.         if (!$lifetime) {
  131.             $lifetime = self::getDefaultLifetime();
  132.         }
  134.         return $instance->getDao()->add($id, $data, $tag, $lifetime);
  135.     }
  137.     /**
  138.      * @param string $id
  139.      *
  140.      * @return void
  141.      */
  142.     public static function delete($id)
  143.     {
  144.         $instance = self::getInstance();
  145.         $instance->getDao()->delete($id);
  146.     }
  148.     /**
  149.      * @param string $id
  150.      *
  151.      * @return null|TmpStore
  152.      */
  153.     public static function get($id)
  154.     {
  155.         $item = new self();
  156.         if ($item->getById($id)) {
  157.             if ($item->getExpiryDate() < time()) {
  158.                 self::delete($id);
  159.             } else {
  160.                 return $item;
  161.             }
  162.         }
  164.         return null;
  165.     }
  167.     /**
  168.      * @param string $tag
  169.      *
  170.      * @return array
  171.      */
  172.     public static function getIdsByTag($tag)
  173.     {
  174.         $instance = self::getInstance();
  175.         $items = $instance->getDao()->getIdsByTag($tag);
  177.         return $items;
  178.     }
  180.     /**
  181.      * @return string
  182.      */
  183.     public function getId()
  184.     {
  185.         return $this->id;
  186.     }
  188.     /**
  189.      * @param string $id
  190.      */
  191.     public function setId($id)
  192.     {
  193.         $this->id = $id;
  194.     }
  196.     /**
  197.      * @return string
  198.      */
  199.     public function getTag()
  200.     {
  201.         return $this->tag;
  202.     }
  204.     /**
  205.      * @param string $tag
  206.      */
  207.     public function setTag($tag)
  208.     {
  209.         $this->tag = $tag;
  210.     }
  212.     /**
  213.      * @return mixed
  214.      */
  215.     public function getData()
  216.     {
  217.         return $this->data;
  218.     }
  220.     /**
  221.      * @param mixed $data
  222.      */
  223.     public function setData($data)
  224.     {
  225.         $this->data = $data;
  226.     }
  228.     /**
  229.      * @return int
  230.      */
  231.     public function getDate()
  232.     {
  233.         return $this->date;
  234.     }
  236.     /**
  237.      * @param int $date
  238.      */
  239.     public function setDate($date)
  240.     {
  241.         $this->date = $date;
  242.     }
  244.     /**
  245.      * @return bool
  246.      */
  247.     public function isSerialized()
  248.     {
  249.         return $this->serialized;
  250.     }
  252.     /**
  253.      * @param bool $serialized
  254.      */
  255.     public function setSerialized($serialized)
  256.     {
  257.         $this->serialized = $serialized;
  258.     }
  260.     /**
  261.      * @return int
  262.      */
  263.     public function getExpiryDate()
  264.     {
  265.         return $this->expiryDate;
  266.     }
  268.     /**
  269.      * @param int $expiryDate
  270.      */
  271.     public function setExpiryDate($expiryDate)
  272.     {
  273.         $this->expiryDate = $expiryDate;
  274.     }
  276.     /**
  277.      * @param int|null $lifetime
  278.      *
  279.      * @return bool
  280.      */
  281.     public function update($lifetime = null)
  282.     {
  283.         if (!$lifetime) {
  284.             $lifetime = 86400;
  285.         }
  287.         return $this->getDao()->add($this->getId(), $this->getData(), $this->getTag(), $lifetime);
  288.     }
  289. }