jakercz / image
Requires
- php: ^5.6 || ^7.0 || ^8.0
- ext-gd: *
- jakercz/cache: 1.0.*
Requires (Dev)
- sllh/php-cs-fixer-styleci-bridge: ~1.0
- symfony/phpunit-bridge: ^2.7.4 || ^3.0
Suggests
- behat/transliterator: Transliterator provides ability to set non-latin1 pretty names
This package is auto-updated.
Last update: 2024-09-25 18:31:51 UTC
README
Gregwar\Image
类的目的是提供一个简单面向对象的图像处理和缓存 API。
安装
使用 composer
composer require jakercz/image
使用方法
基本处理
通过方法链,您可以在一行中打开、转换和保存文件
<?php use Gregwar\Image\Image; Image::open('in.png') ->resize(100, 100) ->negate() ->save('out.jpg');
以下是缩放方法
resize($width, $height, $background)
: 缩放图像,将保留比例且永远不会放大(背景为红色
以便于理解发生了什么)
scaleResize($width, $height, $background)
: 缩放图像,将保留比例,可以放大(背景为红色
以便于理解发生了什么)
forceResize($width, $height, $background)
: 强制将图像缩放为恰好$width
x$height
cropResize($width, $height, $background)
: 缩放图像,保留比例(就像resize()
)并裁剪空白部分
zoomCrop($width, $height, $background, $xPos, $yPos)
: 调整并裁剪图像以适应给定尺寸
- 在
zoomCrop()
中,您可以使用$xPos
(中心、左或右)和$yPos
(中心、顶部或底部)来改变缩放图像的位置
其他可用的方法包括
-
crop($x, $y, $w, $h)
: 裁剪图像到坐标 $x,y 上的一个盒子,大小为 $w x $h -
negate()
: 取反图像颜色 -
brighness($b)
: 对图像应用亮度效果(从 -255 到 +255) -
contrast($c)
: 对图像应用对比度效果(从 -100 到 +100) -
grayscale()
: 将图像转换为灰度 -
emboss()
: 浮雕图像 -
smooth($p)
: 平滑图像 -
sharp()
: 对图像应用平均去除滤波器 -
edge()
: 对图像应用边缘效果 -
colorize($red, $green, $blue)
: 着色图像(每个颜色从 -255 到 +255) -
sepia()
: 应用棕褐色效果 -
merge($image, $x, $y, $width, $height)
: 合并两个图像 -
fill($color, $x, $y)
: 使用给定颜色填充图像 -
write($font, $text, $x, $y, $size, $angle, $color, $position)
: 在图像上写入文本,$position 可以是 'left'、'right' 或 'center' 之一 -
rectangle($x1, $y1, $x2, $y2, $color, $filled=false)
: 绘制矩形 -
rotate($angle, $background = 0xffffff)
: 将图像旋转到给定角度 -
roundedRectangle($x1, $y1, $x2, $y2, $radius, $color, $filled=false)
: 绘制圆角矩形(半径可以是任何值) -
line($x1, $y1, $x2, $y2, $color)
: 绘制线 -
ellipse($cx, $cy, $width, $height, $color, $filled=false)
: 绘制椭圆 -
circle($cx, $cy, $r, $color, $filled=false)
: 绘制圆形 -
fillBackground($bg=0xffffff)
: 将透明图像的背景填充为 'bg' 颜色 -
fixOrientation()
: 使用图像 EXIF 信息旋转和翻转图像 -
applyExifOrientation(int $exif_rotation_value)
: 使用 EXIF 旋转值旋转和翻转图像 -
html($title = '', $type = 'jpg')
: 返回带有缓存图像的<img ... />
标签 -
flip($flipVertical, $flipHorizontal)
: 在给定方向翻转图像。两个参数都是布尔值,至少必须有一个为 true。 -
inline($type = 'jpg')
: 返回可内嵌的 HTML base64 字符串(请参阅demo/inline.php
)
您还可以使用以下方法从头创建图像
<?php Image::create(200, 100);
其中 200 是宽度,100 是高度
保存图像
您可以使用 save($file, $type = 'jpg', $quality = 80)
将图像保存到显式的文件
<?php // ... $image->save('output.jpg', 'jpg', 85);
您还可以使用get($type = 'jpg', $quality = 80)
获取图片内容,这将返回图片的二进制内容
使用缓存
上述每个操作实际上并不是在打开的图片上应用,而是添加到操作数组中。此操作数组,文件名称、类型和修改时间通过sha1()
进行哈希处理,哈希值用于查找缓存文件。
一旦配置了缓存目录,您可以调用以下方法
-
jpeg($quality = 80)
:即时查找或创建JPEG缓存文件 -
gif()
:即时查找或创建GIF缓存文件 -
png()
:即时查找或创建PNG缓存文件 -
guess($quality = 80)
:猜测类型(使用与输入相同的类型)并即时查找或创建缓存文件 -
setPrettyName($prettyName, $prefix = true)
:为文件设置一个“美观”的名称后缀,如果您想使其更具SEO友好性。例如,如果您将其称为“Fancy Image”,缓存将看起来像something/something-fancy-image.jpg。如果将$prefix
传递给false
(默认为true
),则美观名称将没有任何哈希前缀。如果您想使用非latin1美观名称,必须安装behat/transliterator
包。
例如
<?php use Gregwar\Image\Image; echo Image::open('test.png') ->sepia() ->jpeg(); //Outputs: cache/images/1/8/6/9/c/86e4532dbd9c073075ef08e9751fc9bc0f4.jpg
如果原始文件和操作没有改变,哈希值将保持不变,并且不会再次生成缓存。
您可以直接将其用于HTML文档中
<?php use Gregwar\Image\Image; // ... <img src="<?php echo Image::open('image.jpg')->resize(150, 150)->jpeg(); ?>" /> // ...
这很强大,因为如果更改原始图像或任何代码,缓存的哈希值将改变,并将重新生成文件。
写入图像
您还可以使用绘图函数即时创建自己的图像
<?php $img_src = Image::create(300, 300) ->fill(0xffaaaa) // Filling with a light red ->rectangle(0xff3333, 0, 100, 300, 200, true) // Drawing a red rectangle // Writing "Hello $username !" on the picture using a custom TTF font file ->write('./fonts/CaviarDreams.ttf', 'Hello '.$username.'!', 150, 150, 20, 0, 'white', 'center') ->jpeg(); ?> <img src="<?= $img_src ?>" />
使用后备图像
如果图像文件不存在,您可以配置一个后备图像,该图像将由类使用(注意,这需要缓存目录可用)。
默认的“错误”图像位于images/error.jpg
,您可以使用以下方式更改它
<?php $img->setFallback('/path/to/my/fallback.jpg');
垃圾收集
为了防止缓存无限增长,您可以使用以下提供的GarbageCollect类
<?php use Gregwar\Image\GarbageCollect; // This could be a cron called each day @3:00AM for instance // Removes all the files from ../cache that are more than 30 days // old. A verbose output will explain which files are deleted GarbageCollect::dropOldFiles(__DIR__.'/../cache', 30, true);
开发
Gregwar\Image
使用PHP元编程范例,使其易于增强。
处理图像的每个函数都在一个Adapter中实现,这是所有特定操作发生的地方。
Common
适配器旨在包含常见的抽象操作,而特定适配器(如GD
)旨在包含针对低级别层的特定操作。
您可以通过添加相应的适配器来添加自己的方法。
<?php // In the adapter private function myFilter() { $this->negate(); $this->sepia(); }
它可以用在Image上
<?php $image->myFilter();
您还可以编写自己的适配器,它可以扩展此存储库中的任何一个,并通过调用setAdapter()
使用它
<?php $image->setAdapter(new MyCustomAdapter);
许可证
Gregwar\Image
在MIT许可证下,请阅读LICENSE文件以获取更多信息。请随时fork此存储库并自定义它!