vendor/pimcore/pimcore/models/Element/Editlock.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\Element;
  18. use Pimcore\Model;
  19. use Pimcore\Tool\Session;
  21. /**
  22.  * @internal
  23.  *
  24.  * @method \Pimcore\Model\Element\Editlock\Dao getDao()
  25.  * @method void delete()
  26.  * @method void save()
  27.  */
  28. final class Editlock extends Model\AbstractModel
  29. {
  30.     /**
  31.      * @var int
  32.      */
  33.     protected $id;
  35.     /**
  36.      * @var int
  37.      */
  38.     protected $cid;
  40.     /**
  41.      * @var string
  42.      */
  43.     protected $ctype;
  45.     /**
  46.      * @var int
  47.      */
  48.     protected $userId;
  50.     /**
  51.      * @var string
  52.      */
  53.     protected $sessionId;
  55.     /**
  56.      * @var int
  57.      */
  58.     protected $date;
  60.     /**
  61.      * @var string
  62.      */
  63.     protected $cpath;
  65.     /**
  66.      * @param int $cid
  67.      * @param string $ctype
  68.      *
  69.      * @return bool
  70.      */
  71.     public static function isLocked($cid, $ctype)
  72.     {
  73.         if ($lock = self::getByElement($cid, $ctype)) {
  74.             if ((time() - $lock->getDate()) > 3600 || $lock->getSessionId() === Session::getSessionId()) {
  75.                 // lock is out of date unlock it
  76.                 self::unlock($cid, $ctype);
  78.                 return false;
  79.             }
  81.             return true;
  82.         }
  84.         return false;
  85.     }
  87.     /**
  88.      * @param int $cid
  89.      * @param string $ctype
  90.      *
  91.      * @return null|Editlock
  92.      */
  93.     public static function getByElement($cid, $ctype)
  94.     {
  95.         try {
  96.             $lock = new self();
  97.             $lock->getDao()->getByElement($cid, $ctype);
  99.             return $lock;
  100.         } catch (Model\Exception\NotFoundException $e) {
  101.             return null;
  102.         }
  103.     }
  105.     /**
  106.      * @param string $sessionId
  107.      *
  108.      * @return bool|null
  109.      */
  110.     public static function clearSession($sessionId)
  111.     {
  112.         try {
  113.             $lock = new self();
  114.             $lock->getDao()->clearSession($sessionId);
  116.             return true;
  117.         } catch (\Exception $e) {
  118.             return null;
  119.         }
  120.     }
  122.     /**
  123.      * @param int $cid
  124.      * @param string $ctype
  125.      *
  126.      * @return bool|Editlock
  127.      */
  128.     public static function lock($cid, $ctype)
  129.     {
  130.         // try to get user
  131.         if (!$user = \Pimcore\Tool\Admin::getCurrentUser()) {
  132.             return false;
  133.         }
  135.         $lock = new self();
  136.         $lock->setCid($cid);
  137.         $lock->setCtype($ctype);
  138.         $lock->setDate(time());
  139.         $lock->setUserId($user->getId());
  140.         $lock->setSessionId(Session::getSessionId());
  141.         $lock->save();
  143.         return $lock;
  144.     }
  146.     /**
  147.      * @param int $cid
  148.      * @param string $ctype
  149.      *
  150.      * @return bool
  151.      */
  152.     public static function unlock($cid, $ctype)
  153.     {
  154.         if ($lock = self::getByElement($cid, $ctype)) {
  155.             $lock->delete();
  156.         }
  158.         return true;
  159.     }
  161.     /**
  162.      * @return int
  163.      */
  164.     public function getCid()
  165.     {
  166.         return $this->cid;
  167.     }
  169.     /**
  170.      * @return int
  171.      */
  172.     public function getId()
  173.     {
  174.         return $this->id;
  175.     }
  177.     /**
  178.      * @return int
  179.      */
  180.     public function getUserId()
  181.     {
  182.         return $this->userId;
  183.     }
  185.     /**
  186.      * @param int $cid
  187.      *
  188.      * @return $this
  189.      */
  190.     public function setCid($cid)
  191.     {
  192.         $this->cid = (int) $cid;
  194.         return $this;
  195.     }
  197.     /**
  198.      * @param int $id
  199.      *
  200.      * @return $this
  201.      */
  202.     public function setId($id)
  203.     {
  204.         $this->id = (int) $id;
  206.         return $this;
  207.     }
  209.     /**
  210.      * @param int $userId
  211.      *
  212.      * @return $this
  213.      */
  214.     public function setUserId($userId)
  215.     {
  216.         $this->userId = (int) $userId;
  218.         return $this;
  219.     }
  221.     /**
  222.      * @return string
  223.      */
  224.     public function getCtype()
  225.     {
  226.         return $this->ctype;
  227.     }
  229.     /**
  230.      * @param string $ctype
  231.      *
  232.      * @return $this
  233.      */
  234.     public function setCtype($ctype)
  235.     {
  236.         $this->ctype = (string) $ctype;
  238.         return $this;
  239.     }
  241.     /**
  242.      * @return string
  243.      */
  244.     public function getSessionId()
  245.     {
  246.         return $this->sessionId;
  247.     }
  249.     /**
  250.      * @param string $sessionId
  251.      *
  252.      * @return $this
  253.      */
  254.     public function setSessionId($sessionId)
  255.     {
  256.         $this->sessionId = (string) $sessionId;
  258.         return $this;
  259.     }
  261.     /**
  262.      * @return Model\User|null
  263.      */
  264.     public function getUser()
  265.     {
  266.         if ($user = Model\User::getById($this->getUserId())) {
  267.             return $user;
  268.         }
  270.         return null;
  271.     }
  273.     /**
  274.      * @return int
  275.      */
  276.     public function getDate()
  277.     {
  278.         return $this->date;
  279.     }
  281.     /**
  282.      * @param int $date
  283.      *
  284.      * @return $this
  285.      */
  286.     public function setDate($date)
  287.     {
  288.         $this->date = (int) $date;
  290.         return $this;
  291.     }
  293.     /**
  294.      * @param string $cpath
  295.      *
  296.      * @return $this
  297.      */
  298.     public function setCpath($cpath)
  299.     {
  300.         $this->cpath = $cpath;
  302.         return $this;
  303.     }
  305.     /**
  306.      * @return string
  307.      */
  308.     public function getCpath()
  309.     {
  310.         return $this->cpath;
  311.     }
  312. }