vendor/symfony/lock/Key.php line 21

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Component\Lock;
  14. use Symfony\Component\Lock\Exception\UnserializableKeyException;
  16. /**
  17. * Key is a container for the state of the locks in stores.
  18. *
  19. * @author Jérémy Derussé <jeremy@derusse.com>
  20. */
  21. final class Key
  22. {
  23. private $resource;
  24. private $expiringTime;
  25. private $state = [];
  26. private $serializable = true;
  28. public function __construct(string $resource)
  29. {
  30. $this->resource = $resource;
  31. }
  33. public function __toString(): string
  34. {
  35. return $this->resource;
  36. }
  38. public function hasState(string $stateKey): bool
  39. {
  40. return isset($this->state[$stateKey]);
  41. }
  43. public function setState(string $stateKey, $state): void
  44. {
  45. $this->state[$stateKey] = $state;
  46. }
  48. public function removeState(string $stateKey): void
  49. {
  50. unset($this->state[$stateKey]);
  51. }
  53. public function getState(string $stateKey)
  54. {
  55. return $this->state[$stateKey];
  56. }
  58. public function markUnserializable(): void
  59. {
  60. $this->serializable = false;
  61. }
  63. public function resetLifetime()
  64. {
  65. $this->expiringTime = null;
  66. }
  68. /**
  69. * @param float $ttl the expiration delay of locks in seconds
  70. */
  71. public function reduceLifetime(float $ttl)
  72. {
  73. $newTime = microtime(true) + $ttl;
  75. if (null === $this->expiringTime || $this->expiringTime > $newTime) {
  76. $this->expiringTime = $newTime;
  77. }
  78. }
  80. /**
  81. * Returns the remaining lifetime in seconds.
  82. */
  83. public function getRemainingLifetime(): ?float
  84. {
  85. return null === $this->expiringTime ? null : $this->expiringTime - microtime(true);
  86. }
  88. public function isExpired(): bool
  89. {
  90. return null !== $this->expiringTime && $this->expiringTime <= microtime(true);
  91. }
  93. public function __sleep(): array
  94. {
  95. if (!$this->serializable) {
  96. throw new UnserializableKeyException('The key cannot be serialized.');
  97. }
  99. return ['resource', 'expiringTime', 'state'];
  100. }
  101. }