Handler
2 years ago
Proxy
2 years ago
MetadataBag.php
2 years ago
MockArraySessionStorage.php
2 years ago
MockFileSessionStorage.php
2 years ago
NativeSessionStorage.php
2 years ago
PhpBridgeSessionStorage.php
2 years ago
SessionStorageInterface.php
2 years ago
MetadataBag.php
172 lines
| 1 | <?php |
| 2 | |
| 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 | * |
| 11 | * Modified by impress-org on 23-January-2024 using Strauss. |
| 12 | * @see https://github.com/BrianHenryIE/strauss |
| 13 | */ |
| 14 | |
| 15 | namespace Give\Vendors\Symfony\Component\HttpFoundation\Session\Storage; |
| 16 | |
| 17 | use Give\Vendors\Symfony\Component\HttpFoundation\Session\SessionBagInterface; |
| 18 | |
| 19 | /** |
| 20 | * Metadata container. |
| 21 | * |
| 22 | * Adds metadata to the session. |
| 23 | * |
| 24 | * @author Drak <drak@zikula.org> |
| 25 | */ |
| 26 | class MetadataBag implements SessionBagInterface |
| 27 | { |
| 28 | const CREATED = 'c'; |
| 29 | const UPDATED = 'u'; |
| 30 | const LIFETIME = 'l'; |
| 31 | |
| 32 | /** |
| 33 | * @var string |
| 34 | */ |
| 35 | private $name = '__metadata'; |
| 36 | |
| 37 | /** |
| 38 | * @var string |
| 39 | */ |
| 40 | private $storageKey; |
| 41 | |
| 42 | /** |
| 43 | * @var array |
| 44 | */ |
| 45 | protected $meta = [self::CREATED => 0, self::UPDATED => 0, self::LIFETIME => 0]; |
| 46 | |
| 47 | /** |
| 48 | * Unix timestamp. |
| 49 | * |
| 50 | * @var int |
| 51 | */ |
| 52 | private $lastUsed; |
| 53 | |
| 54 | /** |
| 55 | * @var int |
| 56 | */ |
| 57 | private $updateThreshold; |
| 58 | |
| 59 | /** |
| 60 | * @param string $storageKey The key used to store bag in the session |
| 61 | * @param int $updateThreshold The time to wait between two UPDATED updates |
| 62 | */ |
| 63 | public function __construct($storageKey = '_sf2_meta', $updateThreshold = 0) |
| 64 | { |
| 65 | $this->storageKey = $storageKey; |
| 66 | $this->updateThreshold = $updateThreshold; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * {@inheritdoc} |
| 71 | */ |
| 72 | public function initialize(array &$array) |
| 73 | { |
| 74 | $this->meta = &$array; |
| 75 | |
| 76 | if (isset($array[self::CREATED])) { |
| 77 | $this->lastUsed = $this->meta[self::UPDATED]; |
| 78 | |
| 79 | $timeStamp = time(); |
| 80 | if ($timeStamp - $array[self::UPDATED] >= $this->updateThreshold) { |
| 81 | $this->meta[self::UPDATED] = $timeStamp; |
| 82 | } |
| 83 | } else { |
| 84 | $this->stampCreated(); |
| 85 | } |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Gets the lifetime that the session cookie was set with. |
| 90 | * |
| 91 | * @return int |
| 92 | */ |
| 93 | public function getLifetime() |
| 94 | { |
| 95 | return $this->meta[self::LIFETIME]; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Stamps a new session's metadata. |
| 100 | * |
| 101 | * @param int $lifetime Sets the cookie lifetime for the session cookie. A null value |
| 102 | * will leave the system settings unchanged, 0 sets the cookie |
| 103 | * to expire with browser session. Time is in seconds, and is |
| 104 | * not a Unix timestamp. |
| 105 | */ |
| 106 | public function stampNew($lifetime = null) |
| 107 | { |
| 108 | $this->stampCreated($lifetime); |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * {@inheritdoc} |
| 113 | */ |
| 114 | public function getStorageKey() |
| 115 | { |
| 116 | return $this->storageKey; |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Gets the created timestamp metadata. |
| 121 | * |
| 122 | * @return int Unix timestamp |
| 123 | */ |
| 124 | public function getCreated() |
| 125 | { |
| 126 | return $this->meta[self::CREATED]; |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * Gets the last used metadata. |
| 131 | * |
| 132 | * @return int Unix timestamp |
| 133 | */ |
| 134 | public function getLastUsed() |
| 135 | { |
| 136 | return $this->lastUsed; |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * {@inheritdoc} |
| 141 | */ |
| 142 | public function clear() |
| 143 | { |
| 144 | // nothing to do |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * {@inheritdoc} |
| 149 | */ |
| 150 | public function getName() |
| 151 | { |
| 152 | return $this->name; |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Sets name. |
| 157 | * |
| 158 | * @param string $name |
| 159 | */ |
| 160 | public function setName($name) |
| 161 | { |
| 162 | $this->name = $name; |
| 163 | } |
| 164 | |
| 165 | private function stampCreated($lifetime = null) |
| 166 | { |
| 167 | $timeStamp = time(); |
| 168 | $this->meta[self::CREATED] = $this->meta[self::UPDATED] = $this->lastUsed = $timeStamp; |
| 169 | $this->meta[self::LIFETIME] = (null === $lifetime) ? ini_get('session.cookie_lifetime') : $lifetime; |
| 170 | } |
| 171 | } |
| 172 |