ginkgo\Image

图片处理

类摘要

namespace ginkgo;

class Image {
  // 属性
  public $error;
  public $rule = 'md5';
  public $quality = 90;
  public $imageMimes = array();
  public $thumbs  = array();
  public $infoDst = array();

  public $infoSrc = array(
    'width'    => 0,
    'height'   => 0,
    'name'     => '',
    'ext'      => '',
    'mime'     => '',
    'path'     => '',
  );

  protected static $instance;

  private $imageMimesThis = array(
    'gif' => array(
      'image/gif',
    ),
    'jpg' => array(
      'image/jpeg',
      'image/pjpeg'
    ),
    'jpeg' => array(
      'image/jpeg',
      'image/pjpeg'
    ),
    'jpe' => array(
      'image/jpeg',
      'image/pjpeg'
    ),
    'png' => array(
      'image/png',
      'image/x-png'
    ),
    'bmp' => array(
      'image/bmp',
      'image/ms-bmp',
      'image/x-bmp',
      'image/x-bitmap',
      'image/x-xbitmap',
      'image/x-win-bitmap',
      'image/x-windows-bmp',
      'image/x-ms-bmp',
      'application/bmp',
      'application/x-bmp',
      'application/x-win-bitmap'
    ),
  );

  private $res_imgSrc;
  private $res_imgDst;
  private $obj_file;
  private $imageExts;

  // 方法
  public static instance( [ array $imageMimes ] ) : object
  public config( array $imageMimes )
  public open( string $path ) : mixed
  public stamp( string $stamp [, array $font [, mixed $size = false [, mixed $posi = false [, int $angle = 0 [, int $pct = 100 ]]]]] ) : object
  public crop( int $width, int $height [, int $x_src = 0 [, int $y_src = 0 [, mixed $width_src = false [, mixed $height_src = false ]]]] ) : object
  public thumb( [ int $width = 100 [, int $height = 100 [, string $type = 'ratio' ]]] ) : object
  public output( [ mixed $path = null [, mixed $mime = false [, mixed $quality = false [, int $interlace = 1 ]]]] ) : bool
  public save( [ mixed $dir = false [, mixed $name = false [, mixed $quality = false [, int $interlace = 1 ]]]] ) : bool
  public batThumb( array $thumbRows ) : bool
  public getThumbs() : array
  public getMime( string $path [, bool $strict = false ] ) : string
  public getExt( string $path [, mixed $mime = false ] ) : string
  public getInfo( [ string $name ] ) : mixed
  public getError() : string
  public rule( string $rule )

  protected __construct( [ array $imageMimes ] ) : object
  protected __clone()

  private openProcess( string $path ) : mixed
  private createImgBg( int $width, int $height [, mixed $mime = false [, bool $transparent = true [, bool $savealpha = true ]]] ) : mixed
  private verifyFile( string $ext [, string $mime ] ) : bool
  private imgSizeProcess( string $path ) : array
  private txtStampInit( array $font, string $string ) : array
  private stampSizeProcess( array $size, array $stamp ) : array
  private stampPosiProcess( array $posi, resouce $imgDst ) : array
  private colorProcess( mixed $color ) : array
  private rgbProcess( array $color ) : array
  private genFilename( [ bool $name = true ] ) : string
  private dstProcess( string $path [, string $width = '' [, string $height = '' [, string $type = '' ]]] ) : array
  private thumbSizeProcess( int $width_dst, int $height_dst [, string $type = 'ratio' ] ) : array
  private ptToPx( int $pt ) : int
  private fontProcess() : string
  private errRecord( string $msg ) // since 0.2.4
}

成员目录

$infoSrc 原始图片信息

public $infoSrc;

结构

instance() 实例化方法

public static function instance() : object

参数

• 无

返回

• 本类的实例

config() 配置

public function config( array $imageMimes )

参数

• imageMimes 图片 MIME

返回

• 无

open() 打开一个图片文件

public function open( string $path ) : mixed

参数

• path 路径

返回

• 成功返回图片信息和资源，失败返回 false

stamp() 水印

public function stamp( string $stamp [, array $font [, mixed $size = false [, mixed $posi = false [, int $angle = 0 [, int $pct = 100 ]]]]] ) : object

参数

• stamp 文字或水印图片路径，

  当本参数为路径且图片文件不存在，或 `font` 参数不为空时代表文字水印
  

• font 字体

• size 水印尺寸
• posi 水印位置
• angle 水印旋转角度，0 - 360 之间
• pct 水印透明度，0 - 100 之间，0 代表透明，100 代表不透明

返回

• 本类的实例

crop() 裁切图片

public function crop( int $width, int $height [, int $x_src = 0 [, int $y_src = 0 [, mixed $width_src = false [, mixed $height_src = false ]]]] ) : object

参数

• width 目的宽度
• height 目的高度
• x_src 原始图片的 x 点
• y_src 原始图片的 y 点
• width_src 源宽度
• height_src 源高度

返回

• 本类的实例

thumb() 生成缩略图

public function thumb( [ int $width = 100 [, int $height = 100 [, string $type = 'ratio' ]]] ) : object

参数

• width 目的宽度
• height 目的高度
• type ratio 代表按比例缩小，crop 代表裁切

返回

• 本类的实例

output() 输出图片

public function output( [ mixed $path = null [, mixed $mime = false [, mixed $quality = false [, int $interlace = 1 ]]]] ) : bool

参数

• path 路径，为 null 是代表直接输出
• mime 生成图片 MIME 类型，为 false 代表根据源图生成
• quality 图片质量，0 - 100 之间，仅对 jpg 和 png 有效，数字越大质量越好
• interlace jpg 隔行扫描

返回

• 输出是否成功

save() 保存图片

public function save( [ $path = false [, $name = false [, $type = false [, $quality = 90 [, $interlace = true ]]]]] ) : bool // 0.2.0 前
public function save( [ $path = false [, $name = false [, $quality = 90 [, $interlace = true ]]]] ) : bool // 0.2.0 及以后

参数

• path 保存目录

  此参数为 false 时，与原图片同目录。

• name 文件名

  此参数为 false 时，系统会自动生成。

• type 保存类型 0.2.0 弃用

  如 name 参数指定了扩展名，则系统将按照扩展名类型保存，此参数自动失效。

  可能的值

  值	描述
  false（默认值）	系原图片相同
  jpe	JPG 图片
  jpg	JPG 图片
  jpeg	JPG 图片
  pjpeg	JPG 图片
  gif	GIF 图片
  png	PNG 图片
  x-png	PNG 图片
  bmp	BMP 图片
  x-ms-bmp	BMP 图片
  x-windows-bmp	BMP 图片

• quality 图片质量

  仅对 JPG 有效，默认为 90

• interlace 是否设置隔行扫描

  仅对 JPG 有效，默认为 true

  设置隔行扫描的情况下，浏览时是从上到下逐行显示，否则图片是由模糊到清晰整个显示。

返回

• 布尔值

batThumb() 批量生成缩略图

批量生成缩略图会自动调用 save() 方法。

public function batThumb( array $thumbRows ) : bool

参数

• thumbRows 缩略图列表，例如：

  $thumbRows = array(
    array(
      'thumb_width'   => 100,
      'thumb_height'  => 100,
      'thumb_type'    => 'ratio',
    ),
    array(
      'thumb_width'   => 150,
      'thumb_height'  => 200,
      'thumb_type'    => 'crop',
    ),
  );
  

返回

• 布尔值

getThumbs() 获取缩略图

public function getThumbs() : array

参数

• 无

返回

• 批量生成的缩略图列表

getMime() 获取 MIME 类型

public function getMime( string $path [, bool $strict = false ] ) : string

参数

• path 路径
• strict 严格严格检测

返回

• MIME 类型

getExt() 获取扩展名

public function getExt( string $path [, mixed $mime = false ] ) : string

参数

• path 路径
• mime MIME 类型

返回

• 扩展名

getInfo() 获取文件信息

public function getInfo( [ string $name ] ) : mixed

参数

• name 信息名称

返回

• 文件信息

getError() 获取错误

public function getError() : string

参数

• 无

返回

• MIME 类型

rule() 设置生成文件名规则

public function rule( string $rule )

参数

• rule 生成文件名规则（函数名）

返回

• 无

openProcess() 打开图片处理

private function openProcess( string $path ) : mixed

参数

• path 图片路径

返回

• 成功返回图片信息和资源，失败返回 false

createImgBg() 创建图片背景

private function createImgBg( int $width, int $height [, mixed $mime = false [, bool $transparent = true [, bool $savealpha = true ]]] ) : mixed

参数

• width 目的宽度
• height 目的高度
• mime 生成图片 MIME 类型，为 false 代表根据源图生成
• transparent 是否设为透明背景，仅对 png 与 gif 有效
• savealpha 是否保留 Alpha 通道，仅对 png 有效

返回

• 图片资源

verifyFile() 验证是否为允许的文件

private function verifyFile( string $ext [, string $mime ] ) : bool

参数

• ext 扩展名
• mime MIME

返回

• 布尔值

imgSizeProcess() 图片类型检测处理

private function imgSizeProcess( string $path ) : array

参数

• path 图片路径

返回

• 图片信息，详见 $infoSrc

txtStampInit() 文字水印初始化

private function txtStampInit( array $font, string $string ) : array

参数

• font 字体，可以为数字或数组，为数字时代表字号（pt），为数组时结构如下

  键名	类型	描述
  size	int	字号（pt）
  color	mixed	颜色
  file	string	字体文件

• string 文字内容

返回

• 初始化数组

stampSizeProcess() 水印尺寸处理

private function stampSizeProcess( array $size, array $stamp ) : array

参数

• size 水印尺寸，如为空，系统会根据字号或者水印图片自动计算

  键名	类型	描述
  width	mixed	水印宽度
  height	mixed	水印高度

• stamp 水印初始信息，通常此参数由系统根据字号或者水印图片自动计算

  键名	类型	描述
  width	mixed	水印宽度
  height	mixed	水印高度

返回

• 尺寸数组

stampPosiProcess() 水印位置处理

private function stampPosiProcess( array $posi, resouce $imgDst ) : array

参数

• posi 水印位置

  可以为字符串、数字、或数组

  • 字符串例子：lt 左上、rt 右上、lb 左下、rb 右下
  • 数字：10 离上边和左边各 10px、-10 离右边和下边各 10px
  • 数组：array(10,10) 离上边和左边各 10px、array(-10,-10) 离右边和下边各 10px、array(10,-10) 离上边和右边各 10px、array('x' => 10, 'y' => 10) 离上边和左边各 10px

• imgDst 目标图片资源

返回

• 位置数组

colorProcess() 颜色处理

private function colorProcess( mixed $color ) : array

参数

• color 颜色值

  可以为字符串或数组，以下例子均代表白色

  • 字符串例子：rgb(255,255,255)、(255,255,255)、255,255,255、#FFFFFF、FFFFFF
  • 数组例子：array(255,255,255)、array(0xFF,0xFF,0xFF)

返回

• 颜色 RGB 数组

rgbProcess() RGB 处理

private function rgbProcess( array $color ) : array

参数

• color 颜色，必须为数组，以下例子均代表白色

  array(255,255,255)、array(0xFF,0xFF,0xFF)

返回

• 颜色 RGB 数组

genFilename() 生成文件名

private function genFilename( [ bool $name = true ] ) : string

参数

• name true 时按规则生成文件名，false 时使用原始文件名

返回

• 文件名

dstProcess() 目的处理

private function dstProcess( string $path [, string $width = '' [, string $height = '' [, string $type = '' ]]] ) : array

参数

• path 路径
• width 宽度
• height 高度
• type ratio 代表按比例缩小，crop 代表裁切

返回

• 目的数组

thumbSizeProcess() 缩略图尺寸处理

private function thumbSizeProcess( int $width_dst, int $height_dst [, string $type = 'ratio' ] ) : array

参数

• width_dst 目的宽度
• height_dst 目的高度
• type ratio 代表按比例缩小，crop 代表裁切

返回

• 缩略图数组

ptToPx() PT 转 PX

private function ptToPx( int $pt ) : int

参数

• pt 字号（pt）

返回

• 字号（px）

fontProcess() 随机获取字体文件

private function fontProcess() : string

参数

• 无

返回

• 随机返回字体文件路径

errRecord() 记录错误

0.2.4 新增

private function errRecord( string $msg )

参数

• #msg 错误信息