SimpleImage 类使用与技术文档

SimpleImage 是一个 PHP 类，它尽可能简化图像处理的操作。本文档将详细介绍如何安装、使用 SimpleImage 类，以及如何使用其 API。

1. 安装指南

通过 Composer 安装

composer require claviska/simpleimage

手动安装

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

2. 项目使用说明

以下是一个 SimpleImage 类的基本使用示例：

<?php
try {
  // 创建一个新的 SimpleImage 对象
  $image = new \claviska\SimpleImage();

  // 加载图像
  $image->fromFile('image.jpg');

  // 自动调整方向
  $image->autoOrient();

  // 调整大小
  $image->resize(320, 200);

  // 水平翻转
  $image->flip('x');

  // 着色
  $image->colorize('DarkBlue');

  // 添加边框
  $image->border('black', 10);

  // 添加水印
  $image->overlay('watermark.png', 'bottom right');

  // 保存新图像
  $image->toFile('new-image.png', 'image/png');

  // 输出到屏幕
  $image->toScreen();
} catch(Exception $err) {
  // 处理错误
  echo $err->getMessage();
}

3. 项目 API 使用文档

SimpleImage 类的 API 设计以简洁易用为主，以下是 API 的基本使用方法：

载入图像

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) - 作为字符串的原始图像数据。

返回 SimpleImage 对象。

保存图像

toDataUri($mimeType, $options)

生成数据 URI。

• $mimeType (string) - 输出的图像格式 MIME 类型（默认为原始 MIME 类型）。
• $options (array|int) - 选项数组或图像质量百分比。

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

toDownload($filename, $mimeType, $options)

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

• $filename* (string) - 发送到客户端的文件名（不包括路径）。
• $mimeType (string) - 输出的图像格式 MIME 类型（默认为原始 MIME 类型）。
• $options (array|int) - 选项数组或图像质量百分比。

返回 SimpleImage 对象。

toFile($file, $mimeType, $options)

将图像写入文件。

• $file (string) - 要写入的文件。
• $mimeType (string) - 输出的图像格式 MIME 类型（默认为原始 MIME 类型）。
• $options (array|int) - 选项数组或图像质量百分比。

返回 SimpleImage 对象。

toScreen($mimeType, $options)

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

• $mimeType (string) - 输出的图像格式 MIME 类型（默认为原始 MIME 类型）。
• $options (array|int) - 选项数组或图像质量百分比。

返回 SimpleImage 对象。

toString($mimeType, $options)

生成图像字符串。

• $mimeType (string) - 输出的图像格式 MIME 类型（默认为原始 MIME 类型）。
• $options (array|int) - 选项数组或图像质量百分比。

返回 SimpleImage 对象。

generate($mimeType, $options)

生成图像。

• $mimeType (string) - 输出的图像格式 MIME 类型（默认为原始 MIME 类型）。
• $options (array|int) - 选项数组或图像质量百分比。

返回包含 MIME 类型和数据的数组。

实用工具

getAspectRatio()

获取图像当前的长宽比。

返回长宽比作为浮点数。

getExif()

获取图像的 EXIF 数据。

返回 EXIF 数据数组或 null（如果没有数据）。

getHeight()

获取图像当前高度。

返回高度作为整数。

getMimeType()

获取载入图像的 MIME 类型。

返回 MIME 类型字符串。

getOrientation()

获取图像当前方向。

返回 'landscape'、'portrait' 或 'square'。

getResolution()

获取图像当前分辨率（DPI）。

返回包含整数的数组：[0 => 宽度 DPI, 1 => 高度 DPI]。

getWidth()

获取图像当前宽度。

返回宽度作为整数。

hasImage()

检查 SimpleImage 对象是否已载入图像。

返回布尔值。

reset()

销毁图像资源。

返回 SimpleImage 对象。

操作

autoOrient()

根据 EXIF 数据旋转图像以纠正方向。如果没有 EXIF 数据，则不会进行任何更改。

返回 SimpleImage 对象。

bestFit($maxWidth, $maxHeight)

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

• $maxWidth* (int) - 图像的最大宽度。
• $maxHeight* (int) - 图像的最大高度。

返回 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* (int) - 要调整到的图像高度。

返回 SimpleImage 对象。

fitToWidth($width) (已废弃)

按比例调整图像大小到特定宽度。

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

• $width* (int) - 要调整到的图像宽度。

返回 SimpleImage 对象。

flip($direction)

水平或垂直翻转图像。

• $direction* (string) - 翻转方向：'x' 或 'y' 或 'both'。

返回 SimpleImage 对象。

maxColors($max, $dither)

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

• $max* (int) - 最大颜色数。
• $dither (boolean) - 是否使用抖动。

返回 SimpleImage 对象。

4. 项目安装方式

请参考“安装指南”部分，您可以通过 Composer 或手动下载并包含 SimpleImage 类文件来安装项目。

以上就是 SimpleImage 类的详细技术文档，希望能够帮助您更好地使用这个 PHP 图像处理库。