| Server IP : 167.235.224.122 / Your IP : 216.73.216.110 Web Server : Apache/2.4.58 (Ubuntu) System : Linux newplayground 6.8.0-136-generic #136-Ubuntu SMP PREEMPT_DYNAMIC Wed Jul 1 21:33:11 UTC 2026 aarch64 User : deploy ( 1000) PHP Version : 8.4.23 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /var/www/html/zukuenfte.net/kirby/src/Option/ |
Upload File : |
<?php
namespace Kirby\Option;
use Kirby\Cms\Block;
use Kirby\Cms\File;
use Kirby\Cms\ModelWithContent;
use Kirby\Cms\Page;
use Kirby\Cms\StructureObject;
use Kirby\Cms\User;
use Kirby\Content\Field;
use Kirby\Exception\InvalidArgumentException;
use Kirby\Toolkit\Collection;
use Kirby\Toolkit\Obj;
/**
* Options derrived from running a query against
* pages, files, users or structures to create
* options out of them.
*
* @package Kirby Option
* @author Bastian Allgeier <bastian@getkirby.com>,
* Nico Hoffmann <nico@getkirby.com>
* @link https://getkirby.com
* @copyright Bastian Allgeier
* @license https://opensource.org/licenses/MIT
*/
class OptionsQuery extends OptionsProvider
{
public function __construct(
public string $query,
public string|null $text = null,
public string|null $value = null,
public string|null $icon = null,
public string|null $info = null
) {
}
protected function collection(array $array): Collection
{
foreach ($array as $key => $value) {
if (is_scalar($value) === true) {
$array[$key] = new Obj([
'key' => new Field(null, 'key', $key),
'value' => new Field(null, 'value', $value),
]);
}
}
return new Collection($array);
}
public static function factory(string|array $props): static
{
if (is_string($props) === true) {
return new static(query: $props);
}
return new static(
query: $props['query'] ?? $props['fetch'],
text : $props['text'] ?? null,
value: $props['value'] ?? null,
icon : $props['icon'] ?? null,
info : $props['info'] ?? null
);
}
/**
* Returns defaults for the following based on item type:
* [query entry alias, default text query, default value query]
*/
protected function itemToDefaults(array|object $item): array
{
return match (true) {
is_array($item),
$item instanceof Obj => [
'arrayItem',
'{{ item.value }}',
'{{ item.value }}'
],
$item instanceof StructureObject => [
'structureItem',
'{{ item.title }}',
'{{ item.id }}'
],
$item instanceof Block => [
'block',
'{{ block.type }}: {{ block.id }}',
'{{ block.id }}'
],
$item instanceof Page => [
'page',
'{{ page.title }}',
'{{ page.id }}'
],
$item instanceof File => [
'file',
'{{ file.filename }}',
'{{ file.id }}'
],
$item instanceof User => [
'user',
'{{ user.username }}',
'{{ user.email }}'
],
default => [
'item',
'{{ item.value }}',
'{{ item.value }}'
]
};
}
public static function polyfill(array|string $props = []): array
{
if (is_string($props) === true) {
return ['query' => $props];
}
if ($query = $props['fetch'] ?? null) {
$props['query'] ??= $query;
unset($props['fetch']);
}
return $props;
}
/**
* Creates the actual options by running
* the query on the model and resolving it to
* the correct text-value entries
*
* @param bool $safeMode Whether to escape special HTML characters in
* the option text for safe output in the Panel;
* only set to `false` if the text is later escaped!
*/
public function resolve(ModelWithContent $model, bool $safeMode = true): Options
{
// use cached options if present
// @codeCoverageIgnoreStart
if ($this->options !== null) {
return $this->options;
}
// @codeCoverageIgnoreEnd
// run query
$result = $model->query($this->query);
// the query already returned an options collection
if ($result instanceof Options) {
return $result;
}
// convert result to a collection
if (is_array($result) === true) {
$result = $this->collection($result);
}
if ($result instanceof Collection === false) {
$type = is_object($result) === true ? get_class($result) : gettype($result);
throw new InvalidArgumentException('Invalid query result data: ' . $type);
}
// create options array
$options = $result->toArray(function ($item) use ($model, $safeMode) {
// get defaults based on item type
[$alias, $text, $value] = $this->itemToDefaults($item);
$data = ['item' => $item, $alias => $item];
// value is always a raw string
$value = $model->toString($this->value ?? $value, $data);
// text is only a raw string when using {< >}
// or when the safe mode is explicitly disabled (select field)
$safeMethod = $safeMode === true ? 'toSafeString' : 'toString';
$text = $model->$safeMethod($this->text ?? $text, $data);
// additional data
$icon = $this->icon !== null ? $model->toString($this->icon, $data) : null;
$info = $this->info !== null ? $model->$safeMethod($this->info, $data) : null;
return compact('text', 'value', 'icon', 'info');
});
return $this->options = Options::factory($options);
}
}