README

当元素保存时解析Twig并将结果保存为纯文本的字段类型。

要求

此插件需要Craft CMS 5.0.0或更高版本和PHP 8.2.0或更高版本。

安装

要安装此插件，请按照以下说明操作。

1. 打开您的终端并转到您的Craft项目

    cd /path/to/project
   

2. 然后告诉Composer加载插件

    composer require jalendport/craft-preparse
   

3. 在控制面板中，转到设置 → 插件，并点击“安装”按钮以安装Preparse Field。

用法

创建新的Preparse字段时，您可以将要运行的Twig添加到字段的设置中。当保存具有该Preparse字段的元素时，代码将被解析，并将结果值保存为纯文本。

值得注意的是，Preparse字段仅在保存该字段所在的元素时才会更新。如果您从相关元素（如以下示例中的分类标题）中获取数据，然后更新相关元素，预解析的值不会自动更新。

在Twig中，添加Preparse字段的元素可用作名为element的变量。最好使用此变量（而不是像entry或asset这样的东西），因为您可能将相同的Preparse字段添加到多个元素类型。这也意味着当Preparse字段添加到Matrix、SuperTable或Neo块时，该块将作为element可用，因此如果您想访问Matrix/SuperTable/Neo字段所属的元素，您将想要使用element.owner。

示例

如果您在元素上有一个名为relatedCategory的分类字段，您可以通过将以下Twig添加到字段设置中来将分类标题保存到Preparse字段

{{ element.relatedCategory.one().title ?? '' }}

这对于将预解析的值保存到字段以用于排序、搜索或其他类似操作非常有用。

您还可以进行更高级的操作，例如性能优化。假设您有三个可能或可能未填充的不同资产字段。在模板中检查这些可能需要大量查询，因为您不能在Craft中检查字段是否有关系而不实际查询它。您可以这样做来获取要使用的资产id

{% if element.smallListImage | length %}
    {{ element.smallListImage.one().id }}
{% elseif element.largeListImage | length %}
    {{ element.largeListImage.one().id }}
{% elseif element.mainImage | length %}
    {{ element.mainImage.one().id }}
{% endif %}

您可能希望将其包裹在{% apply spaceless %} ... {% endapply %}中以使其更有用...

或者，您可以在保存时使用它来执行一些批量工作，例如使用Imager X预先生成大量图像转换

{% if element.mainImage | length %}
    {% set transformedImages = craft.imager.transformImage(element.mainImage.one(), [
    { width: 1000 },
        { width: 900 },
        { width: 800 },
        { width: 700 },
        { width: 600 },
        { width: 500 },
        { width: 400 },
        { width: 300 },
        { width: 200 },
        { width: 100 }
    ]) %}
{% endif %}

Preparse还可以访问您的站点模板根目录，因此您甚至可以包含本地模板，如果您想进行更高级的操作，或者想将字段的Twig放入版本控制中

{% include '_partials/customPreparseFieldStuff' %}

确保您始终编写健壮的Twig代码，考虑到字段可能尚未填充。如果您的Twig代码出现错误，元素将不会保存。 防御性编程！

价格、许可证和支持

该插件遵循MIT许可证发布，这意味着只要不怪罪我们，您可以随意使用它。 它是免费的，这意味着绝对不包含任何支持，但您可能仍然会得到它。如果您有任何问题，请在此GitHub上发布，我们将看看我们能做什么。 :)

更新日志

请参阅 更新日志文件。