m-paap/simpleimage

一个使图像处理尽可能简单的PHP类。

3.3.3 2017-08-04 12:04 UTC

README

一个使图像处理尽可能简单的PHP类。

复制以进行微小修改,使生成函数保持一致。

Cory LaViska 开发和维护。

如果您因为这个项目再次爱上了PHP图像处理,请考虑为支持其开发进行小额捐赠

概述

<?php
try {
  // Create a new SimpleImage object
  $image = new \claviska\SimpleImage();

  // Magic! ✨
  $image
    ->fromFile('image.jpg')                     // load image.jpg
    ->autoOrient()                              // adjust orientation based on exif data
    ->resize(320, 200)                          // resize to 320x200 pixels
    ->flip('x')                                 // flip horizontally
    ->colorize('DarkBlue')                      // tint dark blue
    ->border('black', 10)                       // add a 10 pixel black border
    ->overlay('watermark.png', 'bottom right')  // add a watermark image
    ->toFile('new-image.png', 'image/png')      // convert to PNG and save a copy to new-image.png
    ->toScreen();                               // output to the screen

  // And much more! 💪
} catch(Exception $err) {
  // Handle errors
  echo $err->getMessage();
}

要求

特性

  • 支持读取、写入和转换GIF、JPEG、PNG、WEBP格式。
  • 读取和写入文件、数据URI和图像字符串。
  • 处理:裁剪、调整大小、叠加/水印、添加TTF文本
  • 绘图:圆弧、边框、点、椭圆、线、多边形、矩形、圆角矩形
  • 过滤器:模糊、亮化、着色、对比度、变暗、去饱和、边缘检测、浮雕、反转、不透明度、像素化、棕褐色、锐化、草图
  • 实用工具:颜色调整、深浅颜色、提取颜色
  • 属性:EXIF数据、高度/宽度、MIME类型、方向
  • 颜色参数可以是任何CSS颜色(例如 LightBlue)、十六进制颜色或RGB(A)数组。
  • 支持Alpha透明度(GIF、PNG、WEBP)
  • 链式方法
  • 使用异常
  • 使用Composer或手动安装(仅一个文件)
  • 语义化版本控制

安装

使用Composer安装

composer require m-paap/simpleimage

或手动包含库

<?php
require 'src/claviska/SimpleImage.php';

关于

SimpleImage由 Cory LaViska 开发和维护。版权所有:A Beautiful Site, LLC。

贡献受到赞赏!如果您喜欢使用SimpleImage,尤其是在商业应用中,请考虑进行捐赠以支持其开发。

谢谢!🙌

许可

MIT许可证下发布。

API

功能顺序

  1. 加载图像
  2. 处理图像
  3. 保存/输出图像

API提示

  • 星号(*)表示必选参数。
  • 返回SimpleImage对象的方法是可链式的。
  • 您可以将文件或数据URI传递给构造函数,以避免调用fromFilefromDataUri
  • 可以使用$image::methodName()\claviska\SimpleImage::methodName()调用静态方法。
  • 颜色可以是CSS颜色(例如 white)、十六进制字符串(例如 #ffffff)或RGBA数组。
  • 当您传递CSS颜色或十六进制字符串时,可以将透明度传递给normalizeColorwhite|0.25

加载器

fromDataUri($uri)

从数据URI加载图像。

  • $uri* (string) - 数据URI。

返回SimpleImage对象。

fromFile($file)

从文件加载图像。

  • $file* (string) - 要加载的图像文件。

返回SimpleImage对象。

fromNew($width, $height, $color)

创建新图像。

  • $width* (int) - 图像宽度。
  • $height* (int) - 图像高度。
  • $color (string|array) - 新图像的填充颜色(默认为'transparent')。

返回SimpleImage对象。

fromString($string)

从字符串创建新图像。

  • $string* (string) - 作为字符串的原始图像数据。例如
    $string = file_get_contents('image.jpg');
    

返回SimpleImage对象。

保存器

toDataUri($mimeType, $quality)

生成数据URI。

  • $mimeType (字符串) - 输出的图像格式作为MIME类型(默认为原始MIME类型)。
  • $quality (整数) - 图像质量作为百分比(默认100)。

返回包含数据URI的字符串。

toDownload($filename, $mimeType, $quality)

强制图像下载到客户端机器。必须在向屏幕发送任何输出之前调用。

  • $filename* (字符串) - 要发送给客户端的文件名(不带路径)(例如,'image.jpeg')。
  • $mimeType (字符串) - 输出的图像格式作为MIME类型(默认为原始MIME类型)。
  • $quality (整数) - 图像质量作为百分比(默认100)。

返回SimpleImage对象。

toFile($file, $mimeType, $quality)

将图像写入文件。

  • $mimeType (字符串) - 输出的图像格式作为MIME类型(默认为原始MIME类型)。
  • $quality (整数) - 图像质量作为百分比(默认100)。

返回SimpleImage对象。

toScreen($mimeType, $quality)

将图像输出到屏幕。必须在向屏幕发送任何输出之前调用。

  • $mimeType (字符串) - 输出的图像格式作为MIME类型(默认为原始MIME类型)。
  • $quality (整数) - 图像质量作为百分比(默认100)。

返回SimpleImage对象。

toString($mimeType, $quality)

生成图像字符串。

  • $mimeType (字符串) - 输出的图像格式作为MIME类型(默认为原始MIME类型)。
  • $quality (整数) - 图像质量作为百分比(默认100)。

返回SimpleImage对象。

工具

getAspectRatio()

获取图像的当前宽高比。

以浮点数返回宽高比。

getExif()

获取图像的EXIF数据。

返回EXIF数据数组或不可用时的null。

getHeight()

获取图像的当前高度。

以整数返回高度。

getMimeType()

获取加载图像的MIME类型。

返回MIME类型字符串。

getOrientation()

获取图像的当前方向。

返回字符串:'landscape'(风景),'portrait'(肖像)或'square'(正方形)。

getWidth()

获取图像的当前宽度。

以整数返回宽度。

操作

autoOrient()

根据EXIF数据旋转图像以使方向正确。对于没有EXIF数据的图像,调用此方法是安全的(不会进行更改)。返回SimpleImage对象。

bestFit($maxWidth, $maxHeight)

按比例调整图像大小以适应特定的宽度和高度。

  • $maxWidth* (整数) - 图像可以的最大宽度。
  • $maxHeight* (整数) - 图像可以的最大高度。

返回SimpleImage对象。

crop($x1, $y1, $x2, $y2)

裁剪图像。

  • $x1 - 左上角x坐标。
  • $y1 - 左上角y坐标。
  • $x2 - 右下角x坐标。
  • $y2 - 右下角y坐标。

返回SimpleImage对象。

fitToHeight($height) (已弃用)

按比例调整图像大小以适应特定的高度。

此方法在3.2.2版本中已弃用,将在4.0版本中删除。请使用resize(null, $height)代替。

  • $height* (整数) - 调整图像大小的目标高度。

返回SimpleImage对象。

fitToWidth($width) (已弃用)

按比例调整图像大小以适应特定的宽度。

此方法在3.2.2版本中已弃用,将在4.0版本中删除。请使用resize($width, null)代替。

  • $width* (整数) - 调整图像大小的目标宽度。

返回SimpleImage对象。

flip($direction)

水平或垂直翻转图像。

  • $direction* (字符串) - 翻转方向:x|y|both

返回SimpleImage对象。

maxColors($max, $dither)

将图像减少到最大颜色数。

  • $max* (整数) - 要使用的最大颜色数。
  • $dither (布尔值) - 是否使用抖动效果(默认为true)。

返回SimpleImage对象。

overlay($overlay, $anchor, $opacity, $xOffset, $yOffset)

将图像放置在当前图像之上。

  • $overlay* (字符串|SimpleImage) - 要覆盖的图像。这可以是文件名、数据URI或SimpleImage对象。
  • $anchor (字符串) - 锚点:'center'(中心)、'top'(顶部)、'bottom'(底部)、'left'(左侧)、'right'(右侧)、'top left'(左上角)、'top right'(右上角)、'bottom left'(左下角)、'bottom right'(右下角)(默认'center')
  • $opacity (浮点数) - 覆盖层的透明度级别 0-1(默认1)。
  • $xOffset (整数) - 像素水平偏移量(默认0)。
  • $yOffset (整数) - 像素垂直偏移量(默认0)。

返回SimpleImage对象。

resize($width, $height)

将图像调整到指定的尺寸。如果只指定一个尺寸,图像将按比例调整。

  • $width * (int) - 新图像的宽度。
  • $height * (int) - 新图像的高度。

返回SimpleImage对象。

rotate($angle, $backgroundColor)

旋转图像。

  • $angle * (int) - 旋转角度 (-360 - 360)。
  • $backgroundColor (string|array) - 旋转后未覆盖区域的背景颜色(默认 'transparent')。

返回SimpleImage对象。

text($text, $options, &$boundary)

向图像添加文本。

  • $text* (string) - 要添加的文本。
  • $options (array) - 选项数组。
    • fontFile * (string) - 要使用的 TrueType(或兼容)字体文件。
    • size (int) - 字体大小(以像素为单位,默认 12)。
    • color (string|array) - 文本颜色(默认黑色)。
    • anchor (string) - 锚点:'center', 'top', 'bottom', 'left', 'right', 'top left', 'top right', 'bottom left', 'bottom right'(默认 'center')。
    • xOffset (int) - 水平偏移量(以像素为单位,默认 0)。
    • yOffset (int) - 垂直偏移量(以像素为单位,默认 0)。
    • shadow (array) - 文本阴影参数。
      • x * (int) - 水平偏移量(以像素为单位)。
      • y * (int) - 垂直偏移量(以像素为单位)。
      • color * (string|array) - 文本阴影颜色。
  • $boundary (array) - 如果传递,此变量将包含包含文本坐标的数组:[x1, y1, x2, y2, width, height]。这可以用于在将文本添加到图像后计算文本的位置。

返回SimpleImage对象。

thumbnail($width, $height, $anchor)

创建缩略图图像。此函数尝试将图像调整到提供的尺寸,然后裁剪剩余的溢出部分以强制达到所需大小。对于生成缩略图很有用。

  • $width * (int) - 缩略图的宽度。
  • $height * (int) - 缩略图的高度。
  • $anchor (string) - 锚点:'center', 'top', 'bottom', 'left', 'right', 'top left', 'top right', 'bottom left', 'bottom right'(默认 'center')。

返回SimpleImage对象。

绘图

arc($x, $y, $width, $height, $start, $end, $color, $thickness)

绘制弧线。

  • $x * (int) - 弧线中心的 x 坐标。
  • $y * (int) - 弧线中心的 y 坐标。
  • $width * (int) - 弧线的宽度。
  • $height * (int) - 弧线的高度。
  • $start * (int) - 弧线起始角度(以度为单位)。
  • $end * (int) - 弧线结束角度(以度为单位)。
  • $color * (string|array) - 弧线颜色。
  • $thickness (int|string) - 线条厚度(以像素为单位)或 'filled'(默认 1)。

返回SimpleImage对象。

border($color, $thickness)

在图像周围绘制边框。

  • $color * (string|array) - 边框颜色。
  • $thickness (int) - 边框厚度(默认 1)。

返回SimpleImage对象。

dot($x, $y, $color)

绘制单个像素点。

  • $x * (int) - 点的 x 坐标。
  • $y * (int) - 点的 y 坐标。
  • $color * (string|array) - 点的颜色。

返回SimpleImage对象。

ellipse($x, $y, $width, $height, $color, $thickness)

绘制椭圆。

  • $x * (int) - 中心的 x 坐标。
  • $y * (int) - 中心的 y 坐标。
  • $width * (int) - 椭圆的宽度。
  • $height * (int) - 椭圆的高度。
  • $color * (string|array) - 椭圆的颜色。
  • $thickness (int|string) - 线条厚度(以像素为单位)或 'filled'(默认 1)。

返回SimpleImage对象。

fill($color)

使用纯色填充图像。

  • $color (string|array) - 填充颜色。

返回SimpleImage对象。

line($x1, $y1, $x2, $y2, $color, $thickness)

绘制线。

  • $x1 * (int) - 第一个点的 x 坐标。
  • $y1 * (int) - 第一个点的 y 坐标。
  • $x2 * (int) - 第二个点的 x 坐标。
  • $y2 * (int) - 第二个点的 y 坐标。
  • $color (string|array) - 线条颜色。
  • $thickness (int) - 线条粗细(默认 1)。

返回SimpleImage对象。

polygon($vertices, $color, $thickness)

绘制多边形。

  • $vertices * (array) - 多边形顶点数组,包含 x/y 数组。示例
    [
      ['x' => x1, 'y' => y1],
      ['x' => x2, 'y' => y2],
      ['x' => xN, 'y' => yN]
    ]
    
  • $color * (string|array) - 多边形颜色。
  • $thickness (int|string) - 线条厚度(以像素为单位)或 'filled'(默认 1)。

返回SimpleImage对象。

rectangle($x1, $y1, $x2, $y2, $color, $thickness)

绘制矩形。

  • $x1 * (int) - 左上角的 x 坐标。
  • $y1 * (int) - 左上角的 y 坐标。
  • $x2 * (int) - 右下角的 x 坐标。
  • $y2 * (int) - 右下角的 y 坐标。
  • $color * (string|array) - 矩形颜色。
  • $thickness (int|string) - 线条厚度(以像素为单位)或 'filled'(默认 1)。

返回SimpleImage对象。

roundedRectangle($x1, $y1, $x2, $y2, $radius, $color, $thickness)

绘制圆角矩形。

  • $x1 * (int) - 左上角的 x 坐标。
  • $y1 * (int) - 左上角的 y 坐标。
  • $x2 * (int) - 右下角的 x 坐标。
  • $y2 * (int) - 右下角的 y 坐标。
  • $radius * (int) - 像素单位中的边框半径。
  • $color * (string|array) - 矩形颜色。
  • $thickness (int|string) - 线条厚度(以像素为单位)或 'filled'(默认 1)。

返回SimpleImage对象。

过滤器

blur($type, $passes)

应用模糊过滤器。

  • $type (string) - 要使用的模糊算法:'selective','gaussian'(默认 'gaussian')。
  • $passes (int) - 应用过滤器次数,增强效果(默认 1)。

返回SimpleImage对象。

brighten($percentage)

应用亮度过滤器使图像变亮。

  • $percentage * (int) - 图像亮度百分比(0 - 100)。

返回SimpleImage对象。

colorize($color)

应用着色过滤器。

  • $color * (string|array) - 过滤器颜色。

返回SimpleImage对象。

contrast($percentage)

应用对比度过滤器。

  • $percentage * (int) - 调整对比度的百分比(-100 - 100)。

返回SimpleImage对象。

darken($percentage)

应用亮度过滤器使图像变暗。

  • $percentage * (int) - 图像变暗的百分比(0 - 100)。

返回SimpleImage对象。

desaturate()

应用去饱和度(灰度)过滤器。

返回SimpleImage对象。

duotone($lightColor, $darkColor)

应用双色过滤器到图像上。

  • $lightColor * (string|array) - 双色中最亮的颜色。
  • $darkColor * (string|array) - 双色中最暗的颜色。

返回SimpleImage对象。

edgeDetect()

应用边缘检测过滤器。

返回SimpleImage对象。

emboss()

应用浮雕过滤器。

返回SimpleImage对象。

invert()

反转图像的颜色。

返回SimpleImage对象。

opacity()

更改图像的不透明度级别。

  • $opacity * (float) - 所需的不透明度级别(0 - 1)。

返回SimpleImage对象。

pixelate($size)

应用马赛克过滤器。

  • $size (int) - 像素块的大小(默认 10)。

返回SimpleImage对象。

sepia()

通过去饱和度图像并应用棕褐色调来模拟棕褐色效果。

返回SimpleImage对象。

sharpen()

锐化图像。

返回SimpleImage对象。

sketch()

应用均值移除过滤器以产生素描效果。

返回SimpleImage对象。

颜色工具

(static) adjustColor($color, $red, $green, $blue, $alpha)

通过独立增加/减少红/绿/蓝/alpha 值来调整颜色。

  • $color * (string|array) - 要调整的颜色。
  • $red * (int) - 红色调整(-255 - 255)。
  • $green * (int) - 绿色调整(-255 - 255)。
  • $blue * (int) - 蓝色调整(-255 - 255)。
  • $alpha * (float) - Alpha 调整(-1 - 1)。

返回 RGBA 颜色数组。

(static) darkenColor($color, $amount)

加深颜色。

  • $color * (string|array) - 要加深的颜色。
  • $amount * (int) - 加深量(0 - 255)。

返回 RGBA 颜色数组。

extractColors($count = 10, $backgroundColor = null)

类似于人类从图像中提取颜色。™ 此方法需要第三方库 \League\ColorExtractor。如果您使用 Composer,它将自动为您安装。

  • $count(int)- 要提取的最大颜色数(默认为5)。
  • $backgroundColor(string|array)- 默认情况下,任何alpha值大于零的像素将被丢弃。这是因为透明颜色不会像其他颜色那样被感知。例如,在白色背景上,完全透明的黑色看起来是白色的。因此,如果您想考虑透明度,您必须指定一个默认的背景颜色。

返回一个RGBA颜色数组的数组。

getColorAt($x, $y)

获取单个像素的RGBA值。

  • $x *(int)- 像素的水平位置。
  • $y *(int)- 像素的垂直位置。

返回一个RGBA颜色数组,或者在x/y位置超出画布时返回false。

(静态)lightenColor($color, $amount)

使颜色变亮。

  • $color *(string|array)- 要变亮的颜色。
  • $amount * (int) - 加深量(0 - 255)。

返回 RGBA 颜色数组。

(静态)normalizeColor($color)

将十六进制或数组颜色值规范化为格式良好的RGBA数组。

  • $color *(string|array)- 一个CSS颜色名称、十六进制字符串或一个数组 [red, green, blue, alpha]。

您可以通过十六进制字符串和颜色名称来传递alpha透明度。例如

#fff|0.50 <-- 50%白色 red|0.25 <-- 25%红色

返回一个数组:[red, green, blue, alpha]

异常

SimpleImage在出错时抛出标准异常。您应该在代码周围始终使用try/catch块来正确处理它们。

<?php
try {
  $image = new \claviska\SimpleImage('image.jpeg')
  // ...
} catch(Exception $err) {
  echo $err->getMessage();
}

要检查特定的错误,将 $err->getCode() 与定义的错误常量进行比较。

<?php
try {
  $image = new \claviska\SimpleImage('image.jpeg')
  // ...
} catch(Exception $err) {
  if($err->getCode() === $image::ERR_FILE_NOT_FOUND) {
    echo 'File not found!';
  } else {
    echo $err->getMessage();
  }
}

作为一个最佳实践,始终使用定义的常量而不是它们的整数值。这些值可能会在未来版本中更改,并且不会被视为破坏性更改。

  • ERR_FILE_NOT_FOUND - 由于某些原因无法找到或加载指定的文件。
  • ERR_FONT_FILE - 无法加载指定的字体文件。
  • ERR_FREETYPE_NOT_ENABLED - Freetype支持未在您的PHP版本中启用。
  • ERR_GD_NOT_ENABLED - GD扩展未在您的PHP版本中启用。
  • ERR_LIB_NOT_LOADED - 未加载所需的库。
  • ERR_INVALID_COLOR - 作为参数传递了无效的颜色值。
  • ERR_INVALID_DATA_URI - 指定的data URI无效。
  • ERR_INVALID_IMAGE - 指定的图像无效。
  • ERR_UNSUPPORTED_FORMAT - 指定的图像格式无效。
  • ERR_WEBP_NOT_ENABLED - WEBP支持未在您的PHP版本中启用。
  • ERR_WRITE - 无法写入文件系统。

有用的事项

  • 颜色参数可以是CSS颜色名称(例如 LightBlue)、十六进制颜色字符串(例如 #0099dd)或RGB(A)数组(例如 ['red' => 255, 'green' => 0, 'blue' => 0, 'alpha' => 1])。

  • $thickness > 1 时,GD从中心原点绘制所需厚度的线条。例如,一个在 [10, 10, 20, 20] 位置、厚度为3的矩形实际上会在 [9, 9, 21, 21] 处绘制。这适用于所有形状,并且不是SimpleImage库中的错误。

与SimpleImage 2.x的差异

  • 规范化颜色参数(颜色可以是CSS颜色名称、十六进制颜色或RGB(A)数组)。
  • 规范化alpha(不透明度)参数:0(透明)- 1(不透明)
  • text 方法添加了文本阴影。
  • 添加了 fromString() 方法,用于从字符串中加载图像。
  • 添加了 toString() 方法,用于生成图像字符串。
  • 添加了 arc 方法,用于绘制圆弧。
  • 添加了 border 方法,用于绘制边框。
  • 添加了 dot 方法,用于绘制单个像素。
  • 添加了 ellipse 方法,用于绘制椭圆和圆形。
  • 增加了 line 方法用于绘制线条。
  • 增加了 polygon 方法用于绘制多边形。
  • 增加了 rectangle 方法用于绘制矩形。
  • 增加了 roundedRectangle 方法用于绘制圆角矩形。
  • 增加了 adjustColor 方法用于修改RGBA颜色通道以创建相对颜色变化。
  • 增加了 darkenColor 方法用于使颜色变暗。
  • 增加了 extractColors 方法用于从图像中获取最常见的颜色。
  • 增加了 getColorAt 方法用于获取特定像素的RGBA值。
  • 增加了 lightenColor 方法用于使颜色变亮。
  • 增加了 toDownload 方法用于强制图像在客户端机器上下载。
  • 增加了 duotone 滤镜用于创建双色图像。
  • 增加了 sharpen 方法用于锐化图像。
  • 将命名空间从 abeautifulsite 更改为 claviska
  • create 方法更改为 fromNew
  • load 方法更改为 fromFile
  • load_base64 方法更改为 fromDataUri
  • output 方法更改为 toScreen
  • output_base64 方法更改为 toDataUri
  • save 方法更改为 toFile
  • text 方法更改为接受选项数组而不是大量参数。
  • text 方法中移除了文本描边,因为它产生了脏结果且不支持透明度。
  • 移除了 smooth 方法,因为PHP手册中它的参数没有很好地记录。
  • 移除了已弃用的方法 adaptive_resize(使用 thumbnail 代替)。
  • 移除了 get_meta_data(使用 getExifgetHeightgetMimegetOrientationgetWidth 代替)。
  • 增加了 .editorconfig 文件。在提交贡献之前,请确保您的编辑器支持这些设置。
  • 从四个空格更改为两个空格进行缩进(对不起PHP-FIG!)。
  • 从下划线方法命名法更改为camelCase命名法。
  • 根据功能将方法组织成组。
  • 移除了PHPDoc注释。目前,我不希望将它们合并到库中。