LiipImagineBundle 技术文档

1. 安装指南

1.1 下载 Bundle

首先，你需要通过 Composer 下载 LiipImagineBundle。在项目根目录下运行以下命令：

composer require liip/imagine-bundle

1.2 启用 Bundle

在 app/AppKernel.php 文件中注册 Bundle：

public function registerBundles()
{
    $bundles = [
        // 其他 Bundle
        new Liip\ImagineBundle\LiipImagineBundle(),
    ];
    return $bundles;
}

1.3 注册路由

在 app/config/routing.yml 文件中添加以下内容：

liip_imagine:
    resource: "@LiipImagineBundle/Resources/config/routing.xml"

2. 项目的使用说明

2.1 基本概念

LiipImagineBundle 是一个用于 Symfony 项目的图像处理工具包。它允许你通过定义“过滤器集”来对图像进行各种变换。过滤器集可以包含多个过滤器和后处理器。

2.2 创建过滤器集

你可以在 app/config/config.yml 文件中定义过滤器集。例如，创建一个名为 my_thumb 的过滤器集，用于生成缩略图：

liip_imagine:
    resolvers:
        default:
            web_path: ~

    filter_sets:
        cache: ~

        my_thumb:
            quality: 75
            filters:
                thumbnail: { size: [120, 90], mode: outbound }
                background: { size: [124, 94], position: center, color: '#000000' }

2.3 在模板中使用

在 Twig 模板中，你可以使用 imagine_filter 过滤器来应用定义的过滤器集：

<img src="{{ asset('/relative/path/to/image.jpg') | imagine_filter('my_thumb') }}" />

3. 项目 API 使用文档

3.1 过滤器

LiipImagineBundle 提供了多种内置过滤器，如 thumbnail、scale、crop、flip、strip 和 watermark。你也可以创建自定义过滤器。

3.1.1 缩略图过滤器

thumbnail: { size: [120, 90], mode: outbound }

3.1.2 背景过滤器

background: { size: [124, 94], position: center, color: '#000000' }

3.2 后处理器

后处理器用于对生成的图像文件进行进一步处理。常见的后处理器包括 JPEG Optim、Moz JPEG、Opti PNG 和 PNG Quant。

4. 项目安装方式

4.1 通过 Composer 安装

使用 Composer 安装 LiipImagineBundle：

composer require liip/imagine-bundle

4.2 启用 Bundle

在 app/AppKernel.php 文件中注册 Bundle：

public function registerBundles()
{
    $bundles = [
        // 其他 Bundle
        new Liip\ImagineBundle\LiipImagineBundle(),
    ];
    return $bundles;
}

4.3 注册路由

在 app/config/routing.yml 文件中添加以下内容：

liip_imagine:
    resource: "@LiipImagineBundle/Resources/config/routing.xml"

通过以上步骤，你已经成功安装并配置了 LiipImagineBundle，可以在项目中使用它来处理图像。