141 lines
3.1 KiB
PHP
141 lines
3.1 KiB
PHP
|
<?php
|
||
|
|
||
|
/**
|
||
|
* This program is free software; you can redistribute it and/or
|
||
|
* modify it under the terms of the GNU General Public License
|
||
|
* as published by the Free Software Foundation; under version 2
|
||
|
* of the License (non-upgradable).
|
||
|
*
|
||
|
* This program is distributed in the hope that it will be useful,
|
||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
* GNU General Public License for more details.
|
||
|
*
|
||
|
* You should have received a copy of the GNU General Public License
|
||
|
* along with this program; if not, write to the Free Software
|
||
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||
|
*
|
||
|
* Copyright (c) 2020 (original work) Open Assessment Technologies SA;
|
||
|
*/
|
||
|
|
||
|
declare(strict_types=1);
|
||
|
|
||
|
namespace oat\oatbox\cache;
|
||
|
|
||
|
use DateInterval;
|
||
|
use DateTime;
|
||
|
use DateTimeImmutable;
|
||
|
use DateTimeInterface;
|
||
|
use InvalidArgumentException;
|
||
|
use Psr\Cache\CacheItemInterface;
|
||
|
|
||
|
class CacheItem implements CacheItemInterface
|
||
|
{
|
||
|
/** @var string */
|
||
|
private $key;
|
||
|
|
||
|
/** @var mixed */
|
||
|
private $value;
|
||
|
|
||
|
/** @var DateTime */
|
||
|
private $expiry;
|
||
|
|
||
|
/** @var bool */
|
||
|
private $isHit;
|
||
|
|
||
|
/** @var DateTime */
|
||
|
private $currentDateTime;
|
||
|
|
||
|
public function __construct(string $key, bool $hit = false, DateTimeInterface $currentDateTime = null)
|
||
|
{
|
||
|
$this->key = $key;
|
||
|
$this->isHit = $hit;
|
||
|
$this->currentDateTime = $currentDateTime ?? new DateTimeImmutable();
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @inheritDoc
|
||
|
*/
|
||
|
public function getKey(): string
|
||
|
{
|
||
|
return $this->key;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @inheritDoc
|
||
|
*/
|
||
|
public function get()
|
||
|
{
|
||
|
return $this->value;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @inheritDoc
|
||
|
*/
|
||
|
public function isHit(): bool
|
||
|
{
|
||
|
return $this->isHit;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @inheritDoc
|
||
|
*/
|
||
|
public function set($value): self
|
||
|
{
|
||
|
$this->value = $value;
|
||
|
|
||
|
return $this;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @inheritDoc
|
||
|
*/
|
||
|
public function expiresAt($expiration): self
|
||
|
{
|
||
|
if (null === $expiration) {
|
||
|
$this->expiry = null;
|
||
|
|
||
|
return $this;
|
||
|
}
|
||
|
|
||
|
if ($expiration instanceof DateTimeInterface) {
|
||
|
$this->expiry = $expiration->getTimestamp();
|
||
|
|
||
|
return $this;
|
||
|
}
|
||
|
|
||
|
throw new InvalidArgumentException('Expiration date must implement DateTimeInterface or be null');
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @inheritDoc
|
||
|
*
|
||
|
* @param DateInterval|null $time
|
||
|
*/
|
||
|
public function expiresAfter($time): self
|
||
|
{
|
||
|
if (null === $time) {
|
||
|
$this->expiry = null;
|
||
|
|
||
|
return $this;
|
||
|
}
|
||
|
|
||
|
if (is_int($time)) {
|
||
|
$time = new DateInterval(sprintf('PT%dS', $time));
|
||
|
}
|
||
|
|
||
|
if ($time instanceof DateInterval) {
|
||
|
$this->expiry = $this->currentDateTime->add($time)->getTimestamp();
|
||
|
|
||
|
return $this;
|
||
|
}
|
||
|
|
||
|
throw new InvalidArgumentException(
|
||
|
sprintf(
|
||
|
'Expiration date must implement DateTimeInterface or be null, "%s" given.',
|
||
|
gettype($time)
|
||
|
)
|
||
|
);
|
||
|
}
|
||
|
}
|