README

Choices 是一个用于 Kirby 3 的插件，它提供管理前端字段 options 的方法。对于任何在蓝图中有 options 设置的字段（如选择、多选或复选框列表），此插件将加载并返回存储在内容文件中的键的易读文本值。它可以直接在蓝图中设置静态选项，也可以通过 query 或 api 设置加载动态选项。

示例

字段

fields:
    fruits:
        label: Fruits
        type: select
        options:
            apple: Apple
            pear: Pear
            banana: Banana

内容

Title: Choices example

----

Fruits: apple, pear

模板

// Return selected fruits: "Apple Pear"
foreach ($page->fruits()->toChoices() as $fruit) {
    echo $fruit;
}

// Return selected fruits in flipped order: "Pear Apple"
foreach (
    $page
        ->fruits()
        ->toChoices()
        ->flip()
    as $fruit
) {
    echo $fruit;
}

安装

下载

下载并将此存储库复制到 /site/plugins/choices。

Git 子模块

git submodule add https://github.com/hananils/kirby-choices.git site/plugins/choices

Composer

composer require hananils/kirby-choices

字段方法

toChoices()

将字段值转换为具有选定选项文本值的 Choices 集合

$page->fruits()->toChoices();

如果方法传递了可选的 true 值，它将返回蓝图中的所有选项的文本值

$page->fruits()->toChoices(true);

Choices 集合

Choices 集合可以用来遍历所有给定选项并返回它们的值。它提供所有默认 Kirby 集合所知道的方法，如 first()、last()、shuffle()、sort() 等。此外，它还提供了三个方法来简化内容输出

join($separator)

join 方法通过指定的分隔符连接所有字段值。

$separator: 可选分隔符，默认为 ,。

// Will return: Apple, Pear
$page
    ->fruits()
    ->toChoices()
    ->join();

如果您想要更多控制如何连接值（例如，最后一个项目通过 and 连接）- 请查看 List methods 插件。

missing($required)

missing 方法将当前字段值与要检查的必需值数组进行比较，并返回缺失的值。

$required: 要检查的必需值数组。

// Will return: Banana
$page
    ->fruits()
    ->toChoices()
    ->missing(['Apple', 'Banana']);

average($decimals)

average 方法将计算所有选定值的平均值，当处理数值时非常有用。

$decimals: 返回的小数位数。

许可证

此插件由 MIT 许可证提供，由 hana+nils · Büro für Gestaltung。
我们为数字和模拟媒体创建视觉设计。

hananils / kirby-choices

维护者

详细信息