README

此包为基于 Symfony 的项目提供图像操作抽象工具包。

概述

过滤器集：使用任何 Symfony 支持的配置语言（如 YML 和 XML），您可以为指定转换例程创建 过滤器集 定义。这些定义包括一系列 过滤器 和 后处理器，以及其他可选参数。
过滤器：使用 过滤器 应用图像转换。该包提供一系列内置过滤器，实现最常见的转换；例如缩略图、缩放、裁剪、翻转、去除和水印。对于更复杂的转换，您可以轻松创建自己的自定义过滤器。
后处理器：处理由 过滤器 创建的输出二进制图像文件（例如，JPEG、PNG 等）的修改。例如，包括 JPEG 优化、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 包类似。必须执行以下步骤

详细安装说明请参阅文档的安装章节。

配置

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

使用入门

通常，此包通过将过滤器集应用于模板中的图片来工作。您的过滤器集在应用程序的配置文件中定义（通常是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 bin/console liip:imagine:cache:resolve relative/path/to/image1.jpg relative/path/to/image2.jpg

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

$ php bin/console liip:imagine:cache:resolve relative/path/to/image1.jpg --filter=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');

过滤器

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

作为服务使用

如果你需要在控制器中使用你定义的“过滤器集”，你可以从服务容器中获取此组件的FilterService来为你做繁重的工作。

<?php

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

        // 1) Simple filter, OR
        $resourcePath = $imagine->getUrlOfFilteredImage('uploads/foo.jpg', 'my_thumb');
        
        // 2) Runtime configuration
        $runtimeConfig = [
            'thumbnail' => [
                'size' => [200, 200]
            ],
        ];
        $resourcePath = $imagine->getUrlOfFilteredImageWithRuntimeFilters(
            'uploads/foo.jpg',
            'my_thumb',
            $runtimeConfig
        );

        // ..
    }
}

?>

数据根

默认情况下，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

查看Symfony权限文档以获取与macOS和其他环境兼容的命令。

使用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。

文档

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

zaartix / imagine-bundle

维护者

详细信息