interkollektives/lichterei-web
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Upgrade to 3.2.0

Browse Source
This commit is contained in:
Bastian Allgeier
2019-06-25 09:56:08 +02:00
parent 9e18cf635d
commit 9c89153d35
296 changed files with 14408 additions and 2504 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
kirby/src/Cache/ApcuCache.php
View File

@@ -9,17 +9,17 @@ use APCUIterator;
*
* @package Kirby Cache
* @author Bastian Allgeier <bastian@getkirby.com>
* @link http://getkirby.com
* @copyright Bastian Allgeier
* @license MIT
* @link https://getkirby.com
* @copyright Bastian Allgeier GmbH
* @license https://opensource.org/licenses/MIT
*/
class ApcuCache extends Cache
{
/**
* Checks if the current key exists in cache
* Determines if an item exists in the cache
*
* @param string $key
* @param string $key
* @return boolean
*/
public function exists(string $key): bool
@@ -28,7 +28,8 @@ class ApcuCache extends Cache
}
/**
* Flush the entire cache directory
* Flushes the entire cache and returns
* whether the operation was successful
*
* @return boolean
*/
@@ -42,9 +43,10 @@ class ApcuCache extends Cache
}
/**
* Remove an item from the cache
* Removes an item from the cache and returns
* whether the operation was successful
*
* @param string $key
* @param string $key
* @return boolean
*/
public function remove(string $key): bool
@@ -53,10 +55,11 @@ class ApcuCache extends Cache
}
/**
* Retrieve an item from the cache.
* Internal method to retrieve the raw cache value;
* needs to return a Value object or null if not found
*
* @param string $key
* @return mixed
* @param string $key
* @return Kirby\Cache\Value|null
*/
public function retrieve(string $key)
{
@@ -64,20 +67,21 @@ class ApcuCache extends Cache
}
/**
* Write an item to the cache for a given number of minutes.
* Writes an item to the cache for a given number of minutes and
* returns whether the operation was successful
*
* <code>
* // Put an item in the cache for 15 minutes
* Cache::set('value', 'my value', 15);
* // put an item in the cache for 15 minutes
* $cache->set('value', 'my value', 15);
* </code>
*
* @param string $key
* @param mixed $value
* @param int $minutes
* @return void
* @param string $key
* @param mixed $value
* @param int $minutes
* @return boolean
*/
public function set(string $key, $value, int $minutes = 0)
public function set(string $key, $value, int $minutes = 0): bool
{
return apcu_store($this->key($key), $this->value($value, $minutes)->toJson(), $this->expiration($minutes));
return apcu_store($this->key($key), (new Value($value, $minutes))->toJson(), $this->expiration($minutes));
}
}

161
kirby/src/Cache/Cache.php
View File

@@ -4,28 +4,27 @@ namespace Kirby\Cache;
/**
* Cache foundation
* This class doesn't do anything
* and is perfect as foundation for
* other cache drivers and to be used
* when the cache is disabled
* This abstract class is used as
* foundation for other cache drivers
* by extending it
*
* @package Kirby Cache
* @author Bastian Allgeier <bastian@getkirby.com>
* @link http://getkirby.com
* @copyright Bastian Allgeier
* @license MIT
* @link https://getkirby.com
* @copyright Bastian Allgeier GmbH
* @license https://opensource.org/licenses/MIT
*/
class Cache
abstract class Cache
{
/**
* stores all options for the driver
* Stores all options for the driver
* @var array
*/
protected $options = [];
/**
* Set all parameters which are needed to connect to the cache storage
* Sets all parameters which are needed to connect to the cache storage
*
* @param array $options
*/
@@ -35,27 +34,26 @@ class Cache
}
/**
* Write an item to the cache for a given number of minutes.
* Writes an item to the cache for a given number of minutes and
* returns whether the operation was successful;
* this needs to be defined by the driver
*
* <code>
* // Put an item in the cache for 15 minutes
* Cache::set('value', 'my value', 15);
* // put an item in the cache for 15 minutes
* $cache->set('value', 'my value', 15);
* </code>
*
* @param string $key
* @param mixed $value
* @param int $minutes
* @return void
* @param string $key
* @param mixed $value
* @param int $minutes
* @return boolean
*/
public function set(string $key, $value, int $minutes = 0)
{
return null;
}
abstract public function set(string $key, $value, int $minutes = 0): bool;
/**
* Adds the prefix to the key if given
*
* @param string $key
* @param string $key
* @return string
*/
protected function key(string $key): string
@@ -68,30 +66,28 @@ class Cache
}
/**
* Private method to retrieve the cache value
* This needs to be defined by the driver
* Internal method to retrieve the raw cache value;
* needs to return a Value object or null if not found;
* this needs to be defined by the driver
*
* @param string $key
* @return mixed
* @param string $key
* @return Kirby\Cache\Value|null
*/
public function retrieve(string $key)
{
return null;
}
abstract public function retrieve(string $key);
/**
* Get an item from the cache.
* Gets an item from the cache
*
* <code>
* // Get an item from the cache driver
* $value = Cache::get('value');
* // get an item from the cache driver
* $value = $cache->get('value');
*
* // Return a default value if the requested item isn't cached
* $value = Cache::get('value', 'default value');
* // return a default value if the requested item isn't cached
* $value = $cache->get('value', 'default value');
* </code>
*
* @param string $key
* @param mixed $default
* @param string $key
* @param mixed $default
* @return mixed
*/
public function get(string $key, $default = null)
@@ -100,34 +96,31 @@ class Cache
$value = $this->retrieve($key);
// check for a valid cache value
if (!is_a($value, 'Kirby\Cache\Value')) {
if (!is_a($value, Value::class)) {
return $default;
}
// remove the item if it is expired
if (time() >= $value->expires()) {
if ($value->expires() > 0 && time() >= $value->expires()) {
$this->remove($key);
return $default;
}
// get the pure value
$cache = $value->value();
// return the cache value or the default
return $cache ?? $default;
// return the pure value
return $value->value();
}
/**
* Calculates the expiration timestamp
*
* @param int $minutes
* @param int $minutes
* @return int
*/
protected function expiration(int $minutes = 0): int
{
// keep forever if minutes are not defined
// 0 = keep forever
if ($minutes === 0) {
$minutes = 2628000;
return 0;
}
// calculate the time
@@ -135,10 +128,12 @@ class Cache
}
/**
* Checks when an item in the cache expires
* Checks when an item in the cache expires;
* returns the expiry timestamp on success, null if the
* item never expires and false if the item does not exist
*
* @param string $key
* @return mixed
* @param string $key
* @return int|null|false
*/
public function expires(string $key)
{
@@ -146,7 +141,7 @@ class Cache
$value = $this->retrieve($key);
// check for a valid Value object
if (!is_a($value, 'Kirby\Cache\Value')) {
if (!is_a($value, Value::class)) {
return false;
}
@@ -157,19 +152,29 @@ class Cache
/**
* Checks if an item in the cache is expired
*
* @param string $key
* @param string $key
* @return boolean
*/
public function expired(string $key): bool
{
return $this->expires($key) <= time();
$expires = $this->expires($key);
if ($expires === null) {
return false;
} elseif (!is_int($expires)) {
return true;
} else {
return time() >= $expires;
}
}
/**
* Checks when the cache has been created
* Checks when the cache has been created;
* returns the creation timestamp on success
* and false if the item does not exist
*
* @param string $key
* @return mixed
* @param string $key
* @return int|false
*/
public function created(string $key)
{
@@ -177,7 +182,7 @@ class Cache
$value = $this->retrieve($key);
// check for a valid Value object
if (!is_a($value, 'Kirby\Cache\Value')) {
if (!is_a($value, Value::class)) {
return false;
}
@@ -188,8 +193,8 @@ class Cache
/**
* Alternate version for Cache::created($key)
*
* @param string $key
* @return mixed
* @param string $key
* @return int|false
*/
public function modified(string $key)
{
@@ -197,48 +202,34 @@ class Cache
}
/**
* Returns Value object
* Determines if an item exists in the cache
*
* @param mixed $value The value, which should be cached
* @param int $minutes The number of minutes before expiration
* @return Value
*/
protected function value($value, int $minutes): Value
{
return new Value($value, $minutes);
}
/**
* Determine if an item exists in the cache.
*
* @param string $key
* @param string $key
* @return boolean
*/
public function exists(string $key): bool
{
return !$this->expired($key);
return $this->expired($key) === false;
}
/**
* Remove an item from the cache
* Removes an item from the cache and returns
* whether the operation was successful;
* this needs to be defined by the driver
*
* @param string $key
* @param string $key
* @return boolean
*/
public function remove(string $key): bool
{
return true;
}
abstract public function remove(string $key): bool;
/**
* Flush the entire cache
* Flushes the entire cache and returns
* whether the operation was successful;
* this needs to be defined by the driver
*
* @return boolean
*/
public function flush(): bool
{
return true;
}
abstract public function flush(): bool;
/**
* Returns all passed cache options

112
kirby/src/Cache/FileCache.php
View File

@@ -2,7 +2,6 @@
namespace Kirby\Cache;
use Exception;
use Kirby\Toolkit\Dir;
use Kirby\Toolkit\F;
@@ -11,80 +10,107 @@ use Kirby\Toolkit\F;
*
* @package Kirby Cache
* @author Bastian Allgeier <bastian@getkirby.com>
* @link http://getkirby.com
* @copyright Bastian Allgeier
* @license MIT
* @link https://getkirby.com
* @copyright Bastian Allgeier GmbH
* @license https://opensource.org/licenses/MIT
*/
class FileCache extends Cache
{
/**
* Set all parameters which are needed for the file cache
* see defaults for available parameters
*
* @param array $params
* Full root including prefix
* @var string
*/
public function __construct(array $params)
protected $root;
/**
* Sets all parameters which are needed for the file cache
*
* @param array $options 'root' (required)
* 'prefix' (default: none)
* 'extension' (file extension for cache files, default: none)
*/
public function __construct(array $options)
{
$defaults = [
'root' => null,
'prefix' => null,
'extension' => null
];
parent::__construct(array_merge($defaults, $params));
parent::__construct(array_merge($defaults, $options));
// build the full root including prefix
$this->root = $this->options['root'];
if (empty($this->options['prefix']) === false) {
$this->root .= '/' . $this->options['prefix'];
}
// try to create the directory
Dir::make($this->options['root'], true);
Dir::make($this->root, true);
}
/**
* Returns the full path to a file for a given key
*
* @param string $key
* @param string $key
* @return string
*/
protected function file(string $key): string
{
$extension = isset($this->options['extension']) ? '.' . $this->options['extension'] : '';
$file = $this->root . '/' . $key;
return $this->options['root'] . '/' . $this->key($key) . $extension;
if (isset($this->options['extension'])) {
return $file . '.' . $this->options['extension'];
} else {
return $file;
}
}
/**
* Write an item to the cache for a given number of minutes.
* Writes an item to the cache for a given number of minutes and
* returns whether the operation was successful
*
* <code>
* // Put an item in the cache for 15 minutes
* Cache::set('value', 'my value', 15);
* // put an item in the cache for 15 minutes
* $cache->set('value', 'my value', 15);
* </code>
*
* @param string $key
* @param mixed $value
* @param int $minutes
* @param string $key
* @param mixed $value
* @param int $minutes
* @return boolean
*/
public function set(string $key, $value, int $minutes = 0)
public function set(string $key, $value, int $minutes = 0): bool
{
return F::write($this->file($key), $this->value($value, $minutes)->toJson());
$file = $this->file($key);
return F::write($file, (new Value($value, $minutes))->toJson());
}
/**
* Retrieve an item from the cache.
* Internal method to retrieve the raw cache value;
* needs to return a Value object or null if not found
*
* @param string $key
* @return mixed
* @param string $key
* @return Kirby\Cache\Value|null
*/
public function retrieve(string $key)
{
return Value::fromJson(F::read($this->file($key)));
$file = $this->file($key);
return Value::fromJson(F::read($file));
}
/**
* Checks when the cache has been created
* Checks when the cache has been created;
* returns the creation timestamp on success
* and false if the item does not exist
*
* @param string $key
* @return int
* @return mixed
*/
public function created(string $key): int
public function created(string $key)
{
// use the modification timestamp
// as indicator when the cache has been created/overwritten
@@ -92,37 +118,39 @@ class FileCache extends Cache
// get the file for this cache key
$file = $this->file($key);
return file_exists($file) ? filemtime($this->file($key)) : 0;
return file_exists($file) ? filemtime($this->file($key)) : false;
}
/**
* Remove an item from the cache
* Removes an item from the cache and returns
* whether the operation was successful
*
* @param string $key
* @param string $key
* @return boolean
*/
public function remove(string $key): bool
{
return F::remove($this->file($key));
$file = $this->file($key);
if (is_file($file) === true) {
return F::remove($file);
} else {
return false;
}
}
/**
* Flush the entire cache directory
* Flushes the entire cache and returns
* whether the operation was successful
*
* @return boolean
*/
public function flush(): bool
{
$root = $this->options['root'];
if (empty($this->options['prefix']) === false) {
$root = $root . '/' . $this->options['prefix'];
}
if (Dir::remove($root) === true && Dir::make($root) === true) {
if (Dir::remove($this->root) === true && Dir::make($this->root) === true) {
return true;
}
return false;
return false; // @codeCoverageIgnore
}
}

107
kirby/src/Cache/MemCached.php
View File

@@ -3,14 +3,14 @@
namespace Kirby\Cache;
/**
* Memcached Driver
*
* @package Kirby Cache
* @author Bastian Allgeier <bastian@getkirby.com>
* @link http://getkirby.com
* @copyright Bastian Allgeier
* @license MIT
*/
* Memcached Driver
*
* @package Kirby Cache
* @author Bastian Allgeier <bastian@getkirby.com>
* @link https://getkirby.com
* @copyright Bastian Allgeier GmbH
* @license https://opensource.org/licenses/MIT
*/
class MemCached extends Cache
{
@@ -21,12 +21,13 @@ class MemCached extends Cache
protected $connection;
/**
* Set all parameters which are needed for the memcache client
* see defaults for available parameters
* Sets all parameters which are needed to connect to Memcached
*
* @param array $params
* @param array $options 'host' (default: localhost)
* 'port' (default: 11211)
* 'prefix' (default: null)
*/
public function __construct(array $params = [])
public function __construct(array $options = [])
{
$defaults = [
'host' => 'localhost',
@@ -34,47 +35,37 @@ class MemCached extends Cache
'prefix' => null,
];
parent::__construct(array_merge($defaults, $params));
parent::__construct(array_merge($defaults, $options));
$this->connection = new \Memcached();
$this->connection->addServer($this->options['host'], $this->options['port']);
}
/**
* Write an item to the cache for a given number of minutes.
* Writes an item to the cache for a given number of minutes and
* returns whether the operation was successful
*
* <code>
* // Put an item in the cache for 15 minutes
* Cache::set('value', 'my value', 15);
* // put an item in the cache for 15 minutes
* $cache->set('value', 'my value', 15);
* </code>
*
* @param string $key
* @param mixed $value
* @param int $minutes
* @return void
* @param string $key
* @param mixed $value
* @param int $minutes
* @return boolean
*/
public function set(string $key, $value, int $minutes = 0)
public function set(string $key, $value, int $minutes = 0): bool
{
return $this->connection->set($this->key($key), $this->value($value, $minutes)->toJson(), $this->expiration($minutes));
return $this->connection->set($this->key($key), (new Value($value, $minutes))->toJson(), $this->expiration($minutes));
}
/**
* Returns the full keyname
* including the prefix (if set)
* Internal method to retrieve the raw cache value;
* needs to return a Value object or null if not found
*
* @param string $key
* @return string
*/
public function key(string $key): string
{
return $this->options['prefix'] . $key;
}
/**
* Retrieve the CacheValue object from the cache.
*
* @param string $key
* @return object CacheValue
* @param string $key
* @return Kirby\Cache\Value|null
*/
public function retrieve(string $key)
{
@@ -82,9 +73,10 @@ class MemCached extends Cache
}
/**
* Remove an item from the cache
* Removes an item from the cache and returns
* whether the operation was successful
*
* @param string $key
* @param string $key
* @return boolean
*/
public function remove(string $key): bool
@@ -93,40 +85,9 @@ class MemCached extends Cache
}
/**
* Checks when an item in the cache expires
*
* @param string $key
* @return int
*/
public function expires(string $key): int
{
return parent::expires($this->key($key));
}
/**
* Checks if an item in the cache is expired
*
* @param string $key
* @return boolean
*/
public function expired(string $key): bool
{
return parent::expired($this->key($key));
}
/**
* Checks when the cache has been created
*
* @param string $key
* @return int
*/
public function created(string $key): int
{
return parent::created($this->key($key));
}
/**
* Flush the entire cache directory
* Flushes the entire cache and returns
* whether the operation was successful;
* WARNING: Memcached only supports flushing the whole cache at once!
*
* @return boolean
*/

83
kirby/src/Cache/MemoryCache.php Executable file
View File

@@ -0,0 +1,83 @@
<?php
namespace Kirby\Cache;
/**
* Memory Cache Driver (cache in memory for current request only)
*
* @package Kirby Cache
* @author Lukas Bestle <lukas@getkirby.com>
* @link https://getkirby.com
* @copyright Bastian Allgeier GmbH
* @license https://opensource.org/licenses/MIT
*/
class MemoryCache extends Cache
{
/**
* Cache data
* @var array
*/
protected $store = [];
/**
* Writes an item to the cache for a given number of minutes and
* returns whether the operation was successful
*
* <code>
* // put an item in the cache for 15 minutes
* $cache->set('value', 'my value', 15);
* </code>
*
* @param string $key
* @param mixed $value
* @param int $minutes
* @return boolean
*/
public function set(string $key, $value, int $minutes = 0): bool
{
$this->store[$key] = new Value($value, $minutes);
return true;
}
/**
* Internal method to retrieve the raw cache value;
* needs to return a Value object or null if not found
*
* @param string $key
* @return Kirby\Cache\Value|null
*/
public function retrieve(string $key)
{
return $this->store[$key] ?? null;
}
/**
* Removes an item from the cache and returns
* whether the operation was successful
*
* @param string $key
* @return boolean
*/
public function remove(string $key): bool
{
if (isset($this->store[$key])) {
unset($this->store[$key]);
return true;
} else {
return false;
}
}
/**
* Flushes the entire cache and returns
* whether the operation was successful
*
* @return boolean
*/
public function flush(): bool
{
$this->store = [];
return true;
}
}

70
kirby/src/Cache/NullCache.php Executable file
View File

@@ -0,0 +1,70 @@
<?php
namespace Kirby\Cache;
/**
* Dummy Cache Driver (does not do any caching)
*
* @package Kirby Cache
* @author Lukas Bestle <lukas@getkirby.com>
* @link https://getkirby.com
* @copyright Bastian Allgeier GmbH
* @license https://opensource.org/licenses/MIT
*/
class NullCache extends Cache
{
/**
* Writes an item to the cache for a given number of minutes and
* returns whether the operation was successful
*
* <code>
* // put an item in the cache for 15 minutes
* $cache->set('value', 'my value', 15);
* </code>
*
* @param string $key
* @param mixed $value
* @param int $minutes
* @return boolean
*/
public function set(string $key, $value, int $minutes = 0): bool
{
return true;
}
/**
* Internal method to retrieve the raw cache value;
* needs to return a Value object or null if not found
*
* @param string $key
* @return Kirby\Cache\Value|null
*/
public function retrieve(string $key)
{
return null;
}
/**
* Removes an item from the cache and returns
* whether the operation was successful
*
* @param string $key
* @return boolean
*/
public function remove(string $key): bool
{
return true;
}
/**
* Flushes the entire cache and returns
* whether the operation was successful
*
* @return boolean
*/
public function flush(): bool
{
return true;
}
}

72
kirby/src/Cache/Value.php
View File

@@ -7,31 +7,31 @@ use Throwable;
/**
* Cache Value
* Stores the value, creation timestamp and expiration timestamp
* and makes it possible to store all three with a single cache key.
* and makes it possible to store all three with a single cache key
*
* @package Kirby Cache
* @author Bastian Allgeier <bastian@getkirby.com>
* @link http://getkirby.com
* @copyright Bastian Allgeier
* @license MIT
* @link https://getkirby.com
* @copyright Bastian Allgeier GmbH
* @license https://opensource.org/licenses/MIT
*/
class Value
{
/**
* the cached value
* Cached value
* @var mixed
*/
protected $value;
/**
* the expiration timestamp
* the number of minutes until the value expires
* @var int
*/
protected $expires;
protected $minutes;
/**
* the creation timestamp
* Creation timestamp
* @var int
*/
protected $created;
@@ -40,18 +40,13 @@ class Value
* Constructor
*
* @param mixed $value
* @param int $minutes the number of minutes until the value expires
* @param int $created the unix timestamp when the value has been created
* @param int $minutes the number of minutes until the value expires
* @param int $created the unix timestamp when the value has been created
*/
public function __construct($value, int $minutes = 0, $created = null)
public function __construct($value, int $minutes = 0, int $created = null)
{
// keep forever if minutes are not defined
if ($minutes === 0) {
$minutes = 2628000;
}
$this->value = $value;
$this->minutes = $minutes;
$this->minutes = $minutes ?? 0;
$this->created = $created ?? time();
}
@@ -66,12 +61,18 @@ class Value
}
/**
* Returns the expiration date as UNIX timestamp
* Returns the expiration date as UNIX timestamp or
* null if the value never expires
*
* @return int
* @return int|null
*/
public function expires(): int
public function expires(): ?int
{
// 0 = keep forever
if ($this->minutes === 0) {
return null;
}
return $this->created + ($this->minutes * 60);
}
@@ -79,32 +80,37 @@ class Value
* Creates a value object from an array
*
* @param array $array
* @return array
* @return self
*/
public static function fromArray(array $array): self
public static function fromArray(array $array)
{
return new static($array['value'] ?? null, $array['minutes'] ?? 0, $array['created'] ?? null);
}
/**
* Creates a value object from a json string
* Creates a value object from a JSON string;
* returns null on error
*
* @param string $json
* @return array
* @return self|null
*/
public static function fromJson($json): self
public static function fromJson(string $json)
{
try {
$array = json_decode($json, true) ?? [];
} catch (Throwable $e) {
$array = [];
}
$array = json_decode($json, true);
return static::fromArray($array);
if (is_array($array)) {
return static::fromArray($array);
} else {
return null;
}
} catch (Throwable $e) {
return null;
}
}
/**
* Convert the object to a json string
* Converts the object to a JSON string
*
* @return string
*/
@@ -114,7 +120,7 @@ class Value
}
/**
* Convert the object to an array
* Converts the object to an array
*
* @return array
*/
@@ -128,7 +134,7 @@ class Value
}
/**
* Returns the value
* Returns the pure value
*
* @return mixed
*/