README

此扩展包为基于Symfony的项目提供图像处理抽象工具集。

概述

• 过滤器集：使用任何Symfony支持的配置语言（如YML和XML），您可以创建指定转换过程的过滤器集定义。这些定义包括一组过滤器和后处理器，以及其他可选参数。

• 过滤器：使用过滤器应用图像转换。扩展包提供了内置过滤器集，实现最常见的转换；例如缩略图、缩放、裁剪、翻转、去除和水印。对于更高级的转换，您可以轻松创建自己的自定义过滤器。

• 后处理器：由后处理器处理从您的过滤器生成的结果二进制图像文件的修改。示例包括JPEG Optim、Moz JPEG、Opti PNG和PNG Quant。就像过滤器一样，您可以轻松创建自己的自定义后处理器。

示例

假设您定义了一个my_thumb过滤器集，它可以配置为执行任意数量的不同转换。最简单的调用是将图像路径传递给提供的imagine_filter Twig 过滤器。

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

致谢

• 感谢许多贡献者，他们投入了时间和代码来支持这个项目。

• 此扩展包使用独立PHP Imagine 库进行图像转换。

• 此包是从AvalancheImagineBundle派生出来的，目的是使代码更易于扩展。有关此分支的更多理由，请参考AvalancheImagineBundle#25。

设置

安装

使用此包类似于所有Symfony包。以下步骤必须执行

1. 下载Bundle
2. 启用Bundle
3. 注册路由

详细的设置说明可以在文档的安装章节中找到。

配置

有关所有可用配置选项的详细信息，请参阅文档的配置章节。

使用入门

通常，此包通过将过滤器集应用于模板中的图像来工作。您的过滤器集定义在应用程序的配置文件中（通常是app/config/config.yml），并包含一组过滤器、后处理程序和其他可选参数。

我们将在稍后更多地了解后处理程序和其他可用参数，但首先让我们集中精力了解如何定义一个由几个过滤器组成的简单过滤器集。

创建缩略图

在开始之前，我们需要进行一些配置，以确保我们的数据加载器和缓存解析器能够正确运行。在您的配置文件中使用以下模板。

# app/config/config.yml

liip_imagine :

    # configure resolvers
    resolvers :

        # setup the default resolver
        default :

            # use the default web path
            web_path : ~

    # your filter sets are defined here
    filter_sets :

        # use the default cache configuration
        cache : ~

基本配置就绪后，我们将从一个示例开始，该示例满足一个常见用例：创建缩略图。假设我们希望对生成的缩略图应用以下转换

• 将图像缩放到120x90px，并裁剪。
• 在缩放后的图像周围添加2px的黑色边框。
• 调整图像质量为75。

在上述模板的基础上，我们需要定义一个过滤器集（我们将其命名为my_thumb），其中配置了两个过滤器：`thumbnail`和`background` 过滤器。

# app/config/config.yml

liip_imagine :
    resolvers :
        default :
            web_path : ~

    filter_sets :
        cache : ~

        # the name of the "filter set"
        my_thumb :

            # adjust the image quality to 75%
            quality : 75

            # list of transformations to apply (the "filters")
            filters :

                # create a thumbnail: set size to 120x90 and use the "outbound" mode
                # to crop the image when the size ratio of the input differs
                thumbnail  : { size : [120, 90], mode : outbound }

                # create a 2px black border: center the thumbnail on a black background
                # 4px larger to create a 2px border around the final image
                background : { size : [124, 94], position : center, color : '#000000' }

您已创建了一个名为my_thumb的过滤器集，它执行缩略图转换。`thumbnail`过滤器将图像调整到所需的宽度和高度（在本例中为120x90px），而`mode: outbound`选项会导致如果输入比例不同，则结果图像被裁剪。`background`过滤器通过创建124x94px大小的黑色画布并在其中心定位缩略图来生成2px的黑色边框。

注意： 过滤器集可以定义任意数量的过滤器。简单的转换可能只需要一个过滤器，而复杂的转换可以定义任意数量的过滤器。

有其他许多过滤器，但您现在可以使用您新定义的my_thumb 过滤器集立即在模板中使用。

对于基于Twig的模板，使用

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

或者，对于基于PHP的模板，使用

<img src="<?php $this['imagine']->filter('/relative/path/to/image.jpg', 'my_thumb') ?>" />

在幕后，当首次处理页面请求时，该包会即时将过滤器应用于图像。然后对转换后的图像进行缓存，以供后续请求使用。最终的缓存图像路径类似于/media/cache/my_thumb/relative/path/to/image.jpg。

注意：在使用dev环境时，您可能会发现图片无法通过模板助手正确渲染。这通常是因为在您的应用程序配置中启用了intercept_redirect。为了确保图片能够正确渲染，强烈建议禁用此选项。

# app/config/config_dev.yml

web_profiler :
    intercept_redirects : false

运行时选项

有时，您可能已经定义了一个过滤器，它满足了99%的使用场景。在这种情况下，您不必为错误的1%情况定义一个新的过滤器，而是可以通过传递一个选项数组给模板助手来在运行时改变过滤器的行为。

对于基于Twig的模板，使用

{% set runtimeConfig = {"thumbnail": {"size": [50, 50] }} %}

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

或者，对于基于PHP的模板，使用

<?php
$runtimeConfig = array(
    "thumbnail" => array(
        "size" => array(50, 50)
    )
);
?>

<img src="<?php $this['imagine']->filter('/relative/path/to/image.jpg', 'my_thumb', $runtimeConfig) ?>" />

路径解析

有时您需要解析这个包返回的过滤图像的路径。这可以通过使用Symfony的控制台二进制文件或从控制器或其他代码中程序化地轻松实现。

使用控制台解析

您可以使用控制台命令liip:imagine:cache:resolve解析图像URL。唯一的必需参数是一个或多个相对图像路径（这些路径必须通过空格分隔）。

$ php app/console liip:imagine:cache:resolve relative/path/to/image1.jpg relative/path/to/image2.jpg

此外，您还可以使用--filters选项来指定您想解析哪个过滤器（如果省略了--filters选项，将解析所有可用的过滤器）。

$ php app/console liip:imagine:cache:resolve relative/path/to/image1.jpg --filters=my_thumb

程序化解析

您可以使用liip_imagine.cache.manager服务中的getBrowserPath方法在您的代码中解析图像URL。假设您已经将服务分配给一个名为$imagineCacheManager的变量，您将执行以下操作：

$imagineCacheManager->getBrowserPath('/relative/path/to/image.jpg', 'my_thumb');

通常，您需要在控制器中执行此操作。假设您的控制器继承自基本的Symfony控制器，您可以利用继承的get方法来请求liip_imagine.cache.manager服务，然后可以在相对图像路径上调用getBrowserPath以获取其解析位置。

/** @var CacheManager */
$imagineCacheManager = $this->get('liip_imagine.cache.manager');

/** @var string */
$resolvedPath = $imagineCacheManager->getBrowserPath('/relative/path/to/image.jpg', 'my_thumb');

过滤器

此包提供了一套内置的过滤器，并且您也可以轻松地定义自己的过滤器。请参考我们的文档中的过滤器章节。

作为服务使用

如果您需要在控制器中使用您定义的“过滤器集”，您可以从服务容器中获取此包的控制器并自行处理响应。

<?php

class MyController extends Controller
{
    public function indexAction()
    {
        /** @var ImagineController */
        $imagine = $this
            ->container
            ->get('liip_imagine.controller');

        /** @var RedirectResponse */
        $imagemanagerResponse = $imagine
            ->filterAction(
                $this->request,         // http request
                'uploads/foo.jpg',      // original image you want to apply a filter to
                'my_thumb'              // filter defined in config.yml
            );

        /** @var CacheManager */
        $cacheManager = $this
            ->container
            ->get('liip_imagine.cache.manager');

        /** @var string */
        $sourcePath = $cacheManager
            ->getBrowserPath(
                'uploads/foo.jpg',
                'my_thumb'
            );

        // ..
    }
}

?>

如果您需要添加更多逻辑，建议的做法是扩展ImagineController.php或将其作为您自己的实现的基。

要在其他服务中使用控制器，您必须模拟一个新的请求。

<?php

/** @var ImagineController */
$imagine = $this
    ->container
    ->get('liip_imagine.controller');

/** @var Response */
$response = $imagine
    ->filterAction(
        new Symfony\Component\HttpFoundation\Request(),
        'uploads/foo.jpg',
        'my_thumb'
    );

?>

数据根

默认情况下，Symfony的web/目录被注册为数据根，用于加载资源。对于许多安装来说，这将足够，但有时您可能需要从其他位置加载图像。为此，您必须在配置中设置data_root参数（通常位于app/config/config.yml）。

liip_imagine:
    loaders:
        default:
            filesystem:
                data_root: /path/to/source/images/dir

从版本1.7.2开始，您可以注册多个数据根路径，文件定位器将搜索每个路径以查找请求的文件。

liip_imagine:
    loaders:
        default:
            filesystem:
                data_root:
                    - /path/foo
                    - /path/bar

从版本1.7.3开始，您可以请求所有注册的包的公共资源路径自动注册为数据根。这允许您从位于加载的包中的Resources/public文件夹加载资源。要启用此功能，将bundle_resources.enabled配置选项设置为true。

liip_imagine:
    loaders:
        default:
            filesystem:
                bundle_resources:
                    enabled: true

如果您只想注册一些Resource/public文件夹，而不是全部注册，您可以通过黑名单您不想注册的包或白名单您想注册的包来实现。例如，要黑名单（不注册）包“FooBundle”和“BarBundle”，您将使用以下配置。

liip_imagine:
    loaders:
        default:
            filesystem:
                bundle_resources:
                    enabled: true
                    access_control_type: blacklist
                    access_control_list:
                        - FooBundle
                        - BarBundle

或者，如果您只想白名单（仅注册）包“FooBundle”和“BarBundle”，您将使用以下配置。

liip_imagine:
    loaders:
        default:
            filesystem:
                bundle_resources:
                    enabled: true
                    access_control_type: whitelist
                    access_control_list:
                        - FooBundle
                        - BarBundle

权限

图像位置必须可由您的Web服务器读取。在支持 setfacl 的系统上（例如Linux/BSD），请使用

HTTPDUSER=`ps axo user,comm | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\  -f1`

sudo setfacl -R -m u:"$HTTPDUSER":rwX -m u:`whoami`:rwX /path/to/source/images/dir

sudo setfacl -dR -m u:"$HTTPDUSER":rwX -m u:`whoami`:rwX /path/to/source/images/dir

有关与macOS和其他环境兼容的命令，请参阅 Symfony 权限文档。

使用Apache

您需要通过向您的Apache VHost配置中添加以下内容来授予Apache读取权限

<VirtualHost *:80>
    <!-- Rest of directives like DocumentRoot or ServerName -->

    Alias /FavouriteAlias /path/to/source/images/dir
    <Directory "/path/to/source/images/dir">
        AllowOverride None
        Allow from All
    </Directory>
</VirtualHost>

或者，您可以将指令放置在项目中的单独文件中，并在Apache VHost配置中包含它。例如，您可以创建文件 app/config/apache/photos.xml 并在VHost文件中添加以下内容

<VirtualHost *:80>
    <!-- Rest of directives like DocumentRoot or ServerName -->

    Include "/path/to/your/project/app/config/apache/photos.xml"
</VirtualHost>

此方法将文件与您的其他代码一起保持，使您能够轻松更改它或创建不同环境依赖的配置文件。

一旦正确配置了Apache，具有以下绝对路径的图像的相对路径 /path/to/source/images/dir/logo.png 必须是 /FavouriteAlias/logo.png。

文档

有关此包功能的更详细信息，请参阅 文档。