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

@ -18,431 +18,433 @@ use Kirby\Toolkit\A;
*/
abstract class Model
{
/**
* @var \Kirby\Cms\ModelWithContent
*/
protected $model;
/**
* @var \Kirby\Cms\ModelWithContent
*/
protected $model;
/**
* @param \Kirby\Cms\ModelWithContent $model
*/
public function __construct($model)
{
$this->model = $model;
}
/**
* @param \Kirby\Cms\ModelWithContent $model
*/
public function __construct($model)
{
$this->model = $model;
}
/**
* Get the content values for the model
*
* @return array
*/
public function content(): array
{
return Form::for($this->model)->values();
}
/**
* Get the content values for the model
*
* @return array
*/
public function content(): array
{
return Form::for($this->model)->values();
}
/**
* Returns the drag text from a custom callback
* if the callback is defined in the config
* @internal
*
* @param string $type markdown or kirbytext
* @param mixed ...$args
* @return string|null
*/
public function dragTextFromCallback(string $type, ...$args): ?string
{
$option = 'panel.' . $type . '.' . $this->model::CLASS_ALIAS . 'DragText';
$callback = option($option);
/**
* Returns the drag text from a custom callback
* if the callback is defined in the config
* @internal
*
* @param string $type markdown or kirbytext
* @param mixed ...$args
* @return string|null
*/
public function dragTextFromCallback(string $type, ...$args): ?string
{
$option = 'panel.' . $type . '.' . $this->model::CLASS_ALIAS . 'DragText';
$callback = $this->model->kirby()->option($option);
if (
empty($callback) === false &&
is_a($callback, 'Closure') === true &&
($dragText = $callback($this->model, ...$args)) !== null
) {
return $dragText;
}
if (
empty($callback) === false &&
is_a($callback, 'Closure') === true &&
($dragText = $callback($this->model, ...$args)) !== null
) {
return $dragText;
}
return null;
}
return null;
}
/**
* Returns the correct drag text type
* depending on the given type or the
* configuration
*
* @internal
*
* @param string|null $type (`auto`|`kirbytext`|`markdown`)
* @return string
*/
public function dragTextType(string $type = null): string
{
$type ??= 'auto';
/**
* Returns the correct drag text type
* depending on the given type or the
* configuration
*
* @internal
*
* @param string|null $type (`auto`|`kirbytext`|`markdown`)
* @return string
*/
public function dragTextType(string $type = null): string
{
$type ??= 'auto';
if ($type === 'auto') {
$type = option('panel.kirbytext', true) ? 'kirbytext' : 'markdown';
}
if ($type === 'auto') {
$kirby = $this->model->kirby();
$type = $kirby->option('panel.kirbytext', true) ? 'kirbytext' : 'markdown';
}
return $type === 'markdown' ? 'markdown' : 'kirbytext';
}
return $type === 'markdown' ? 'markdown' : 'kirbytext';
}
/**
* Returns the setup for a dropdown option
* which is used in the changes dropdown
* for example.
*
* @return array
*/
public function dropdownOption(): array
{
return [
'icon' => 'page',
'link' => $this->url(),
'text' => $this->model->id(),
];
}
/**
* Returns the setup for a dropdown option
* which is used in the changes dropdown
* for example.
*
* @return array
*/
public function dropdownOption(): array
{
return [
'icon' => 'page',
'link' => $this->url(),
'text' => $this->model->id(),
];
}
/**
* Returns the Panel image definition
*
* @internal
*
* @param string|array|false|null $settings
* @return array|null
*/
public function image($settings = [], string $layout = 'list'): ?array
{
// completely switched off
if ($settings === false) {
return null;
}
/**
* Returns the Panel image definition
*
* @internal
*
* @param string|array|false|null $settings
* @return array|null
*/
public function image($settings = [], string $layout = 'list'): ?array
{
// completely switched off
if ($settings === false) {
return null;
}
// skip image thumbnail if option
// is explicitly set to show the icon
if ($settings === 'icon') {
$settings = [
'query' => false
];
} elseif (is_string($settings) === true) {
// convert string settings to proper array
$settings = [
'query' => $settings
];
}
// skip image thumbnail if option
// is explicitly set to show the icon
if ($settings === 'icon') {
$settings = [
'query' => false
];
} elseif (is_string($settings) === true) {
// convert string settings to proper array
$settings = [
'query' => $settings
];
}
// merge with defaults and blueprint option
$settings = array_merge(
$this->imageDefaults(),
$settings ?? [],
$this->model->blueprint()->image() ?? [],
);
// merge with defaults and blueprint option
$settings = array_merge(
$this->imageDefaults(),
$settings ?? [],
$this->model->blueprint()->image() ?? [],
);
if ($image = $this->imageSource($settings['query'] ?? null)) {
// main url
$settings['url'] = $image->url();
if ($image = $this->imageSource($settings['query'] ?? null)) {
// main url
$settings['url'] = $image->url();
// only create srcsets for resizable files
if ($image->isResizable() === true) {
$settings['src'] = static::imagePlaceholder();
// only create srcsets for resizable files
if ($image->isResizable() === true) {
$settings['src'] = static::imagePlaceholder();
switch ($layout) {
case 'cards':
$sizes = [352, 864, 1408];
break;
case 'cardlets':
$sizes = [96, 192];
break;
case 'list':
default:
$sizes = [38, 76];
break;
}
switch ($layout) {
case 'cards':
$sizes = [352, 864, 1408];
break;
case 'cardlets':
$sizes = [96, 192];
break;
case 'list':
default:
$sizes = [38, 76];
break;
}
if (($settings['cover'] ?? false) === false || $layout === 'cards') {
$settings['srcset'] = $image->srcset($sizes);
} else {
$settings['srcset'] = $image->srcset([
'1x' => [
'width' => $sizes[0],
'height' => $sizes[0],
'crop' => 'center'
],
'2x' => [
'width' => $sizes[1],
'height' => $sizes[1],
'crop' => 'center'
]
]);
}
} elseif ($image->isViewable() === true) {
$settings['src'] = $image->url();
}
}
if (($settings['cover'] ?? false) === false || $layout === 'cards') {
$settings['srcset'] = $image->srcset($sizes);
} else {
$settings['srcset'] = $image->srcset([
'1x' => [
'width' => $sizes[0],
'height' => $sizes[0],
'crop' => 'center'
],
'2x' => [
'width' => $sizes[1],
'height' => $sizes[1],
'crop' => 'center'
]
]);
}
} elseif ($image->isViewable() === true) {
$settings['src'] = $image->url();
}
}
if (isset($settings['query']) === true) {
unset($settings['query']);
}
if (isset($settings['query']) === true) {
unset($settings['query']);
}
// resolve remaining options defined as query
return A::map($settings, function ($option) {
if (is_string($option) === false) {
return $option;
}
// resolve remaining options defined as query
return A::map($settings, function ($option) {
if (is_string($option) === false) {
return $option;
}
return $this->model->toString($option);
});
}
return $this->model->toString($option);
});
}
/**
* Default settings for Panel image
*
* @return array
*/
protected function imageDefaults(): array
{
return [
'back' => 'pattern',
'color' => 'gray-500',
'cover' => false,
'icon' => 'page',
'ratio' => '3/2',
];
}
/**
* Default settings for Panel image
*
* @return array
*/
protected function imageDefaults(): array
{
return [
'back' => 'pattern',
'color' => 'gray-500',
'cover' => false,
'icon' => 'page',
'ratio' => '3/2',
];
}
/**
* Data URI placeholder string for Panel image
*
* @internal
*
* @return string
*/
public static function imagePlaceholder(): string
{
return 'data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw';
}
/**
* Data URI placeholder string for Panel image
*
* @internal
*
* @return string
*/
public static function imagePlaceholder(): string
{
return 'data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw';
}
/**
* Returns the image file object based on provided query
*
* @internal
*
* @param string|null $query
* @return \Kirby\Cms\File|\Kirby\Filesystem\Asset|null
*/
protected function imageSource(?string $query = null)
{
$image = $this->model->query($query ?? null);
/**
* Returns the image file object based on provided query
*
* @internal
*
* @param string|null $query
* @return \Kirby\Cms\File|\Kirby\Filesystem\Asset|null
*/
protected function imageSource(?string $query = null)
{
$image = $this->model->query($query ?? null);
// validate the query result
if (
is_a($image, 'Kirby\Cms\File') === true ||
is_a($image, 'Kirby\Filesystem\Asset') === true
) {
return $image;
}
// validate the query result
if (
is_a($image, 'Kirby\Cms\File') === true ||
is_a($image, 'Kirby\Filesystem\Asset') === true
) {
return $image;
}
return null;
}
return null;
}
/**
* Checks for disabled dropdown options according
* to the given permissions
*
* @param string $action
* @param array $options
* @param array $permissions
* @return bool
*/
public function isDisabledDropdownOption(string $action, array $options, array $permissions): bool
{
$option = $options[$action] ?? true;
return $permissions[$action] === false || $option === false || $option === 'false';
}
/**
* Checks for disabled dropdown options according
* to the given permissions
*
* @param string $action
* @param array $options
* @param array $permissions
* @return bool
*/
public function isDisabledDropdownOption(string $action, array $options, array $permissions): bool
{
$option = $options[$action] ?? true;
return $permissions[$action] === false || $option === false || $option === 'false';
}
/**
* Returns lock info for the Panel
*
* @return array|false array with lock info,
* false if locking is not supported
*/
public function lock()
{
if ($lock = $this->model->lock()) {
if ($lock->isUnlocked() === true) {
return ['state' => 'unlock'];
}
/**
* Returns lock info for the Panel
*
* @return array|false array with lock info,
* false if locking is not supported
*/
public function lock()
{
if ($lock = $this->model->lock()) {
if ($lock->isUnlocked() === true) {
return ['state' => 'unlock'];
}
if ($lock->isLocked() === true) {
return [
'state' => 'lock',
'data' => $lock->get()
];
}
if ($lock->isLocked() === true) {
return [
'state' => 'lock',
'data' => $lock->get()
];
}
return ['state' => null];
}
return ['state' => null];
}
return false;
}
return false;
}
/**
* Returns an array of all actions
* that can be performed in the Panel
* This also checks for the lock status
*
* @param array $unlock An array of options that will be force-unlocked
* @return array
*/
public function options(array $unlock = []): array
{
$options = $this->model->permissions()->toArray();
/**
* Returns an array of all actions
* that can be performed in the Panel
* This also checks for the lock status
*
* @param array $unlock An array of options that will be force-unlocked
* @return array
*/
public function options(array $unlock = []): array
{
$options = $this->model->permissions()->toArray();
if ($this->model->isLocked()) {
foreach ($options as $key => $value) {
if (in_array($key, $unlock)) {
continue;
}
if ($this->model->isLocked()) {
foreach ($options as $key => $value) {
if (in_array($key, $unlock)) {
continue;
}
$options[$key] = false;
}
}
$options[$key] = false;
}
}
return $options;
}
return $options;
}
/**
* Returns the full path without leading slash
*
* @return string
*/
abstract public function path(): string;
/**
* Returns the full path without leading slash
*
* @return string
*/
abstract public function path(): string;
/**
* Prepares the response data for page pickers
* and page fields
*
* @param array|null $params
* @return array
*/
public function pickerData(array $params = []): array
{
return [
'id' => $this->model->id(),
'image' => $this->image(
$params['image'] ?? [],
$params['layout'] ?? 'list'
),
'info' => $this->model->toSafeString($params['info'] ?? false),
'link' => $this->url(true),
'sortable' => true,
'text' => $this->model->toSafeString($params['text'] ?? false),
];
}
/**
* Prepares the response data for page pickers
* and page fields
*
* @param array|null $params
* @return array
*/
public function pickerData(array $params = []): array
{
return [
'id' => $this->model->id(),
'image' => $this->image(
$params['image'] ?? [],
$params['layout'] ?? 'list'
),
'info' => $this->model->toSafeString($params['info'] ?? false),
'link' => $this->url(true),
'sortable' => true,
'text' => $this->model->toSafeString($params['text'] ?? false),
];
}
/**
* Returns the data array for the
* view's component props
*
* @internal
*
* @return array
*/
public function props(): array
{
$blueprint = $this->model->blueprint();
$tabs = $blueprint->tabs();
$tab = $blueprint->tab(get('tab')) ?? $tabs[0] ?? null;
/**
* Returns the data array for the
* view's component props
*
* @internal
*
* @return array
*/
public function props(): array
{
$blueprint = $this->model->blueprint();
$request = $this->model->kirby()->request();
$tabs = $blueprint->tabs();
$tab = $blueprint->tab($request->get('tab')) ?? $tabs[0] ?? null;
$props = [
'lock' => $this->lock(),
'permissions' => $this->model->permissions()->toArray(),
'tabs' => $tabs,
];
$props = [
'lock' => $this->lock(),
'permissions' => $this->model->permissions()->toArray(),
'tabs' => $tabs,
];
// only send the tab if it exists
// this will let the vue component define
// a proper default value
if ($tab) {
$props['tab'] = $tab;
}
// only send the tab if it exists
// this will let the vue component define
// a proper default value
if ($tab) {
$props['tab'] = $tab;
}
return $props;
}
return $props;
}
/**
* Returns link url and tooltip
* for model (e.g. used for prev/next
* navigation)
*
* @internal
*
* @param string $tooltip
* @return array
*/
public function toLink(string $tooltip = 'title'): array
{
return [
'link' => $this->url(true),
'tooltip' => (string)$this->model->{$tooltip}()
];
}
/**
* Returns link url and tooltip
* for model (e.g. used for prev/next
* navigation)
*
* @internal
*
* @param string $tooltip
* @return array
*/
public function toLink(string $tooltip = 'title'): array
{
return [
'link' => $this->url(true),
'tooltip' => (string)$this->model->{$tooltip}()
];
}
/**
* Returns link url and tooltip
* for optional sibling model and
* preserves tab selection
*
* @internal
*
* @param \Kirby\Cms\ModelWithContent|null $model
* @param string $tooltip
* @return array
*/
protected function toPrevNextLink($model = null, string $tooltip = 'title'): ?array
{
if ($model === null) {
return null;
}
/**
* Returns link url and tooltip
* for optional sibling model and
* preserves tab selection
*
* @internal
*
* @param \Kirby\Cms\ModelWithContent|null $model
* @param string $tooltip
* @return array
*/
protected function toPrevNextLink($model = null, string $tooltip = 'title'): ?array
{
if ($model === null) {
return null;
}
$data = $model->panel()->toLink($tooltip);
$data = $model->panel()->toLink($tooltip);
if ($tab = get('tab')) {
$uri = new Uri($data['link'], [
'query' => ['tab' => $tab]
]);
if ($tab = $model->kirby()->request()->get('tab')) {
$uri = new Uri($data['link'], [
'query' => ['tab' => $tab]
]);
$data['link'] = $uri->toString();
}
$data['link'] = $uri->toString();
}
return $data;
}
return $data;
}
/**
* Returns the url to the editing view
* in the Panel
*
* @internal
*
* @param bool $relative
* @return string
*/
public function url(bool $relative = false): string
{
if ($relative === true) {
return '/' . $this->path();
}
/**
* Returns the url to the editing view
* in the Panel
*
* @internal
*
* @param bool $relative
* @return string
*/
public function url(bool $relative = false): string
{
if ($relative === true) {
return '/' . $this->path();
}
return $this->model->kirby()->url('panel') . '/' . $this->path();
}
return $this->model->kirby()->url('panel') . '/' . $this->path();
}
/**
* Returns the data array for
* this model's Panel view
*
* @internal
*
* @return array
*/
abstract public function view(): array;
/**
* Returns the data array for
* this model's Panel view
*
* @internal
*
* @return array
*/
abstract public function view(): array;
}