Update Kirby and dependencies

This commit is contained in:
Paul Nicoué 2022-08-31 15:02:43 +02:00
parent 503b339974
commit 399fa20902
439 changed files with 66915 additions and 64442 deletions

View file

@ -14,8 +14,8 @@ namespace Kirby\Exception;
*/
class BadMethodCallException extends Exception
{
protected static $defaultKey = 'invalidMethod';
protected static $defaultFallback = 'The method "{ method }" does not exist';
protected static $defaultHttpCode = 400;
protected static $defaultData = ['method' => null];
protected static $defaultKey = 'invalidMethod';
protected static $defaultFallback = 'The method "{ method }" does not exist';
protected static $defaultHttpCode = 400;
protected static $defaultData = ['method' => null];
}

View file

@ -15,7 +15,7 @@ namespace Kirby\Exception;
*/
class DuplicateException extends Exception
{
protected static $defaultKey = 'duplicate';
protected static $defaultFallback = 'The entry exists';
protected static $defaultHttpCode = 400;
protected static $defaultKey = 'duplicate';
protected static $defaultFallback = 'The entry exists';
protected static $defaultHttpCode = 400;
}

View file

@ -15,7 +15,7 @@ namespace Kirby\Exception;
*/
class ErrorPageException extends Exception
{
protected static $defaultKey = 'errorPage';
protected static $defaultFallback = 'Triggered error page';
protected static $defaultHttpCode = 404;
protected static $defaultKey = 'errorPage';
protected static $defaultFallback = 'Triggered error page';
protected static $defaultHttpCode = 404;
}

View file

@ -2,6 +2,7 @@
namespace Kirby\Exception;
use Kirby\Http\Environment;
use Kirby\Toolkit\I18n;
use Kirby\Toolkit\Str;
@ -18,208 +19,209 @@ use Kirby\Toolkit\Str;
*/
class Exception extends \Exception
{
/**
* Data variables that can be used inside the exception message
*
* @var array
*/
protected $data;
/**
* Data variables that can be used inside the exception message
*
* @var array
*/
protected $data;
/**
* HTTP code that corresponds with the exception
*
* @var int
*/
protected $httpCode;
/**
* HTTP code that corresponds with the exception
*
* @var int
*/
protected $httpCode;
/**
* Additional details that are not included in the exception message
*
* @var array
*/
protected $details;
/**
* Additional details that are not included in the exception message
*
* @var array
*/
protected $details;
/**
* Whether the exception message could be translated into the user's language
*
* @var bool
*/
protected $isTranslated = true;
/**
* Whether the exception message could be translated into the user's language
*
* @var bool
*/
protected $isTranslated = true;
/**
* Defaults that can be overridden by specific
* exception classes
*/
protected static $defaultKey = 'general';
protected static $defaultFallback = 'An error occurred';
protected static $defaultData = [];
protected static $defaultHttpCode = 500;
protected static $defaultDetails = [];
/**
* Defaults that can be overridden by specific
* exception classes
*/
protected static $defaultKey = 'general';
protected static $defaultFallback = 'An error occurred';
protected static $defaultData = [];
protected static $defaultHttpCode = 500;
protected static $defaultDetails = [];
/**
* Prefix for the exception key (e.g. 'error.general')
*
* @var string
*/
private static $prefix = 'error';
/**
* Prefix for the exception key (e.g. 'error.general')
*
* @var string
*/
private static $prefix = 'error';
/**
* Class constructor
*
* @param array|string $args Full option array ('key', 'translate', 'fallback',
* 'data', 'httpCode', 'details' and 'previous') or
* just the message string
*/
public function __construct($args = [])
{
// set data and httpCode from provided arguments or defaults
$this->data = $args['data'] ?? static::$defaultData;
$this->httpCode = $args['httpCode'] ?? static::$defaultHttpCode;
$this->details = $args['details'] ?? static::$defaultDetails;
/**
* Class constructor
*
* @param array|string $args Full option array ('key', 'translate', 'fallback',
* 'data', 'httpCode', 'details' and 'previous') or
* just the message string
*/
public function __construct($args = [])
{
// set data and httpCode from provided arguments or defaults
$this->data = $args['data'] ?? static::$defaultData;
$this->httpCode = $args['httpCode'] ?? static::$defaultHttpCode;
$this->details = $args['details'] ?? static::$defaultDetails;
// define the Exception key
$key = self::$prefix . '.' . ($args['key'] ?? static::$defaultKey);
// define the Exception key
$key = self::$prefix . '.' . ($args['key'] ?? static::$defaultKey);
if (is_string($args) === true) {
$this->isTranslated = false;
parent::__construct($args);
} else {
// define whether message can/should be translated
$translate = ($args['translate'] ?? true) === true && class_exists('Kirby\Cms\App') === true;
if (is_string($args) === true) {
$this->isTranslated = false;
parent::__construct($args);
} else {
// define whether message can/should be translated
$translate = ($args['translate'] ?? true) === true && class_exists('Kirby\Cms\App') === true;
// fallback waterfall for message string
$message = null;
// fallback waterfall for message string
$message = null;
if ($translate) {
// 1. translation for provided key in current language
// 2. translation for provided key in default language
if (isset($args['key']) === true) {
$message = I18n::translate(self::$prefix . '.' . $args['key']);
$this->isTranslated = true;
}
}
if ($translate) {
// 1. translation for provided key in current language
// 2. translation for provided key in default language
if (isset($args['key']) === true) {
$message = I18n::translate(self::$prefix . '.' . $args['key']);
$this->isTranslated = true;
}
}
// 3. provided fallback message
if ($message === null) {
$message = $args['fallback'] ?? null;
$this->isTranslated = false;
}
// 3. provided fallback message
if ($message === null) {
$message = $args['fallback'] ?? null;
$this->isTranslated = false;
}
if ($translate) {
// 4. translation for default key in current language
// 5. translation for default key in default language
if ($message === null) {
$message = I18n::translate(self::$prefix . '.' . static::$defaultKey);
$this->isTranslated = true;
}
}
if ($translate) {
// 4. translation for default key in current language
// 5. translation for default key in default language
if ($message === null) {
$message = I18n::translate(self::$prefix . '.' . static::$defaultKey);
$this->isTranslated = true;
}
}
// 6. default fallback message
if ($message === null) {
$message = static::$defaultFallback;
$this->isTranslated = false;
}
// 6. default fallback message
if ($message === null) {
$message = static::$defaultFallback;
$this->isTranslated = false;
}
// format message with passed data
$message = Str::template($message, $this->data, [
'fallback' => '-',
'start' => '{',
'end' => '}'
]);
// format message with passed data
$message = Str::template($message, $this->data, [
'fallback' => '-',
'start' => '{',
'end' => '}'
]);
// handover to Exception parent class constructor
parent::__construct($message, 0, $args['previous'] ?? null);
}
// handover to Exception parent class constructor
parent::__construct($message, 0, $args['previous'] ?? null);
}
// set the Exception code to the key
$this->code = $key;
}
// set the Exception code to the key
$this->code = $key;
}
/**
* Returns the file in which the Exception was created
* relative to the document root
*
* @return string
*/
final public function getFileRelative(): string
{
$file = $this->getFile();
/**
* Returns the file in which the Exception was created
* relative to the document root
*
* @return string
*/
final public function getFileRelative(): string
{
$file = $this->getFile();
$docRoot = Environment::getGlobally('DOCUMENT_ROOT');
if (empty($_SERVER['DOCUMENT_ROOT']) === false) {
$file = ltrim(Str::after($file, $_SERVER['DOCUMENT_ROOT']), '/');
}
if (empty($docRoot) === false) {
$file = ltrim(Str::after($file, $docRoot), '/');
}
return $file;
}
return $file;
}
/**
* Returns the data variables from the message
*
* @return array
*/
final public function getData(): array
{
return $this->data;
}
/**
* Returns the data variables from the message
*
* @return array
*/
final public function getData(): array
{
return $this->data;
}
/**
* Returns the additional details that are
* not included in the message
*
* @return array
*/
final public function getDetails(): array
{
return $this->details;
}
/**
* Returns the additional details that are
* not included in the message
*
* @return array
*/
final public function getDetails(): array
{
return $this->details;
}
/**
* Returns the exception key (error type)
*
* @return string
*/
final public function getKey(): string
{
return $this->getCode();
}
/**
* Returns the exception key (error type)
*
* @return string
*/
final public function getKey(): string
{
return $this->getCode();
}
/**
* Returns the HTTP code that corresponds
* with the exception
*
* @return array
*/
final public function getHttpCode(): int
{
return $this->httpCode;
}
/**
* Returns the HTTP code that corresponds
* with the exception
*
* @return array
*/
final public function getHttpCode(): int
{
return $this->httpCode;
}
/**
* Returns whether the exception message could
* be translated into the user's language
*
* @return bool
*/
final public function isTranslated(): bool
{
return $this->isTranslated;
}
/**
* Returns whether the exception message could
* be translated into the user's language
*
* @return bool
*/
final public function isTranslated(): bool
{
return $this->isTranslated;
}
/**
* Converts the object to an array
*
* @return array
*/
public function toArray(): array
{
return [
'exception' => static::class,
'message' => $this->getMessage(),
'key' => $this->getKey(),
'file' => $this->getFileRelative(),
'line' => $this->getLine(),
'details' => $this->getDetails(),
'code' => $this->getHttpCode()
];
}
/**
* Converts the object to an array
*
* @return array
*/
public function toArray(): array
{
return [
'exception' => static::class,
'message' => $this->getMessage(),
'key' => $this->getKey(),
'file' => $this->getFileRelative(),
'line' => $this->getLine(),
'details' => $this->getDetails(),
'code' => $this->getHttpCode()
];
}
}

View file

@ -14,8 +14,8 @@ namespace Kirby\Exception;
*/
class InvalidArgumentException extends Exception
{
protected static $defaultKey = 'invalidArgument';
protected static $defaultFallback = 'Invalid argument "{ argument }" in method "{ method }"';
protected static $defaultHttpCode = 400;
protected static $defaultData = ['argument' => null, 'method' => null];
protected static $defaultKey = 'invalidArgument';
protected static $defaultFallback = 'Invalid argument "{ argument }" in method "{ method }"';
protected static $defaultHttpCode = 400;
protected static $defaultData = ['argument' => null, 'method' => null];
}

View file

@ -14,7 +14,7 @@ namespace Kirby\Exception;
*/
class LogicException extends Exception
{
protected static $defaultKey = 'logic';
protected static $defaultFallback = 'This task cannot be finished';
protected static $defaultHttpCode = 400;
protected static $defaultKey = 'logic';
protected static $defaultFallback = 'This task cannot be finished';
protected static $defaultHttpCode = 400;
}

View file

@ -14,7 +14,7 @@ namespace Kirby\Exception;
*/
class NotFoundException extends Exception
{
protected static $defaultKey = 'notFound';
protected static $defaultFallback = 'Not found';
protected static $defaultHttpCode = 404;
protected static $defaultKey = 'notFound';
protected static $defaultFallback = 'Not found';
protected static $defaultHttpCode = 404;
}

View file

@ -15,7 +15,7 @@ namespace Kirby\Exception;
*/
class PermissionException extends Exception
{
protected static $defaultKey = 'permission';
protected static $defaultFallback = 'You are not allowed to do this';
protected static $defaultHttpCode = 403;
protected static $defaultKey = 'permission';
protected static $defaultFallback = 'You are not allowed to do this';
protected static $defaultHttpCode = 403;
}