README

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

概述

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

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

将图像缩放并裁剪为120x90像素。
在缩放后的图像上添加2像素的黑边。
调整图像质量为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过滤器将图像大小调整为所需的宽度和高度（在本例中为120x90像素），其mode: outbound选项会在输入比例不同时裁剪结果图像。background过滤器通过创建一个124x94像素大小的黑色画布，并将缩略图放置在其中心，从而生成一个2像素的黑边。

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

有多个其他过滤器，但现在您可以在模板中立即使用您新定义的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');

过滤器

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

作为服务使用

如果您需要在控制器内部使用您定义的“过滤器集”，您可以从服务容器中获取此组件的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。

文档

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

prolixlib/ imagine-bundle

维护者

详细信息