README

这是一个用于在 Imager X 中将 ImageBoss 用作转换器的插件。
同时，也是如何制作 Imager X 的自定义转换器的示例。

要求

此插件需要 Craft CMS 5.0.0-beta.1 或更高版本，Imager X 5.0.0-beta.1 或更高版本，并在 ImageBoss 上有一个账户。

用法

按照以下说明安装和配置此转换器。然后，在您的 Imager X 配置中，将转换器设置为 imageboss，即

'transformer' => 'imageboss',

现在默认使用 ImageBoss 进行转换，使用如下简单的转换测试您的配置

{% set transform = craft.imagerx.transformImage(asset, { width: 600 }) %}
<img src="{{ transform.url }}" width="600">
<p>URL is: {{ transform.url }}</p>

如果不起作用，请确保您已配置了 defaultProfile，有一个正确名称的配置文件，并且源已设置使用与您的资产相同的存储桶。

注意事项、缺点和建议

此转换器仅支持默认 craft 转换器使用时 Imager X 可以做的子集。所有基本转换参数都受支持，但有以下例外

只能转换资产。如果您需要转换外部图像，则需要切换到 craft 转换器进行这些转换。
不支持 cropOnly 和 stretch 调整大小模式。
在 letterbox 调整大小模式下不支持颜色的透明度。
仅以下 effects 转换并受支持：grayscale、sharpen、blur 和 gamma。 – 水印不会自动从 Imager 语法转换为 ImageBoss'，但您仍然可以通过在 options 对象中手动传递它们来添加水印（见下文）。

要直接将额外选项传递给 ImageBoss，您可以使用 transformerParams 转换参数，并通过 options 对象传递它们。示例

{% set transforms = craft.imagerx.transformImage(asset, 
    [{width: 400}, {width: 600}, {width: 800}], 
    { ratio: 2/1, transformerParams: { options: 'sharpen:6,grayscale:true' } }
) %}

有关更多信息，请参阅 ImageBoss 文档。

安装

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

使用 composer 在您的项目目录中通过 composer require spacecatninja/imager-x-imageboss-transformer 安装。
在 Craft 控制面板的设置 > 插件下安装插件，或通过命令行通过 ./craft plugin/install imager-x-imageboss-transformer 安装。

配置

您可以通过在您的配置文件夹中创建一个名为 imager-x-imageboss-transformer.php 的文件来配置转换器，并按需覆盖设置。

profiles [数组]

默认：[]
配置文件通常是一对一映射到您在 ImageBoss 中创建的图像源。这通常将映射到您的 Craft 设置中的卷。您可以使用 defaultProfile 配置设置来设置要使用的默认配置文件，并可以在模板级别通过在 transformerParams 中设置 profile 来覆盖它。

示例配置文件

'profiles' => [
    'default' => [
        'sourceName' => 'imagerx-s3',
        'signToken' => '7a7cc5142212378b435edb18b273bec8799e1270272cc49f34836651cd023a28',
        'useCloudSourcePath' => true,
    ],
    'web' => [
        'sourceName' => 'imagerx-web',
        'signToken' => '1b7ca41421125791a31edb18a273bec8792e1970272ad49f34836631cd023a28',
        'useCloudSourcePath' => false,
    ]
],

每个配置文件需要三个设置

sourceName：这是您在 ImageBoss 中选择的“源名称”。

signToken：如果您已启用安全签名的 URL，请在此处添加您的签名令牌。

useCloudSourcePath：如果启用，Imager 将在将路径添加到 ImageBoss URL 之前，将 Craft 源路径添加到资产路径中。这使得当图像位于同一 S3 桶中但不同子文件夹时，一个 ImageBoss 源可以拉取多个 Craft 卷中的图像成为可能。这仅在实现路径设置的卷上工作（AWS S3 和 GCS 支持，本地卷不支持）。

defaultProfile [字符串]

默认值： ''
设置要使用的默认配置文件（参见 profiles）。您可以通过设置 transformParams 转换参数来在转换级别覆盖配置文件。示例

{% set transforms = craft.imagerx.transformImage(asset, 
    [{width: 800}, {width: 2000}], 
    { transformerParams: { profile: 'myotherprofile' } }
) %}

enableCompression [布尔值]

默认值： true
设置为 false 以禁用 ImageBoss 的默认自动压缩功能，该功能会在浏览器支持时自动提供 WebP。

enableProgressive [布尔值]

默认值： true
设置为 false 以禁用 ImageBoss 的默认行为，该行为在可能的情况下提供渐进式 JPEG。

enableAutoRotate [布尔值]

默认值： true
设置为 false 以禁用 ImageBoss 的默认行为，该行为使用图像中的 EXIF 数据来自动旋转图像。

价格、许可证和支持

此插件以 MIT 许可证发布。它需要 Imager X，这是一个商业插件，可在 Craft 插件商店中找到可用。如果您需要帮助或发现了一个错误，请在此存储库或 Imager X 的存储库中（最好是）发布一个问题。

spacecatninja / imager-x-imageboss-transformer

维护者

详细信息