13 Commits

Author SHA1 Message Date
DESKTOP\Administrator e5109dfd39 Added support for multiple image processing drivers 2026-05-03 00:20:29 +03:00
Andrew fef495df07 Update README.md 2025-07-24 00:40:49 +03:00
Andrew e3c759a75a Update README.md 2024-09-27 14:26:29 +03:00
geckon01 dca7db5442 Bump package version 2024-03-25 15:48:59 +03:00
geckon01 178c158618 Fixed Class "http\Exception\BadUrlException" not found exception 2024-03-25 15:47:20 +03:00
DESKTOP-H825VC6\geckon01 1baf7ae2ca Small code style improvements 2023-10-17 02:14:37 +03:00
DESKTOP-H825VC6\geckon01 a7461536bc Bump package version 2023-10-17 02:03:17 +03:00
DESKTOP-H825VC6\geckon01 f9b21bcf05 Added support for webp and bmp 2023-10-17 02:00:50 +03:00
DESKTOP-H825VC6\geckon01 de877f3b6a Better image type recognition with exif 2023-10-17 02:00:17 +03:00
Andrew 10338aec18 Update README.md - fix some typo 2023-06-09 20:21:32 +03:00
Andrew 1e0f13a7a6 Update README.md 2023-03-30 10:17:48 +03:00
geckon01 a538362343 Small code style imporvements 2023-03-30 01:17:41 +03:00
geckon01 a6f42255c8 Updated readme.md 2023-03-30 00:45:07 +03:00
6 changed files with 185 additions and 71 deletions
+25 -17
View File
@@ -2,15 +2,26 @@
# SimpleImageCompressor
[![Software License][ico-license]](LICENSE.md)
**SimpleImageCompressor** - is a tiny simple PHP image compressor lib which allows you to compress any image easily on the fly.
![Version](https://img.shields.io/packagist/v/geckon01/simple-image-compressor)
![Lecense](https://img.shields.io/badge/license-MIT-green)
![Downloads](https://img.shields.io/packagist/dt/geckon01/simple-image-compressor)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d773335a657d467faaa0ebb12bc2abe1)](https://app.codacy.com/gh/Geckon01/simple-image-compressor/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
**SimpleImageCompressor** - is a tiny simple PHP image resizer lib which allows you to resize and compress any image easily on the fly.
## Installation
1. Download latest release [here](https://github.com/Geckon01/simple-image-compressor/releases).
2. Unpack archive to any folder of your project you wish.
3. Load main lib files:
### With composer
```bash
composer require "geckon01/simple-image-compressor"
```
### Without composer
1. Download latest release [here](https://github.com/Geckon01/simple-image-compressor/releases).
2. Unpack the archive to your project directory.
3. Include the library files:
```php
require "src/SimpleImageCompressor.php";
@@ -20,26 +31,25 @@ use geckon01\SimpleImageCompressor\SimpleImageCompressor;
## Usage
To resize and compress your image you can use next code:
Resize and compress an image:
```php
$resulutionTargetPercent = 50;
$resolutionTargetPercent = 50;
$targetQuality = 50;
$compressor = SimpleImageCompressor::load("image.png");
$compressedImage = $compressor->resizeAndCompress($resulutionTargetPercent, $targetQuality);
$compressedImage = $compressor->resizeAndCompress($resolutionTargetPercent, $targetQuality);
$compressedImage->toFile("image");
```
load method supports loading from local file, or you can specify any valid URL image link like this:
```php
$compressor = SimpleImageCompressor::load("https://example.com/image.jpg");
```
This lib support chaining, so you can do something like this:
Method chaining is supported:
```php
SimpleImageCompressor::load("image.png")
->resizeAndCompress(50, 50)
->toFile("image");
```
> Note that you don't need to specify file extension. The lib will save
> file with proper one automatically.
> Note: File extensions are automatically added. Use toFile("filename") without extension.
### Output format
You can specify output format. Supported output fomats are:
@@ -53,17 +63,15 @@ $compressedImage->toBase64();
```php
$compressedImage->toGdImage();
```
### Max/min height/width
Also you can set approximate minumum and maximum image size.
### Size Constraints
Set approximate minimum dimensions (aspect ratio preserved):
```php
$compressor->setApproxMinimumHeight(500);
$compressor->setApproxMinimumWidth(500);
```
> Note that Due to saving proportion lib can't guarantee that width and height be equals max and min .
As example, if we have original image 1920x1080 which we want to get 50% of original resolution and save original 16x9 aspect ration the reduced image must be 960x540.
> Note actual dimensions may differ due to aspect ratio preservation.
Example: 1920×1080 image reduced to 50% becomes 960×540 (maintaining 16:9).
## License
This software is licensed under the MIT License. [View the license](LICENSE.md).
[ico-license]: https://img.shields.io/badge/license-MIT-green
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "geckon01/simple-image-compressor",
"description": "SimpleImageCompressor is a tiny simple PHP image compressor lib which allows you to compress any image easily on the fly",
"version": "0.3.1",
"version": "0.4.3.25",
"keywords": [
"php",
"images",
+14 -2
View File
@@ -57,11 +57,17 @@ class CompressedImage
imagejpeg($this->imageObject, null, $this->qualityRate);
break;
case "image/png":
imagepng( $this->imageObject, null, self::mapValue($this->qualityRate, 0, 100, 0, 9));
imagepng($this->imageObject, null, self::mapValue($this->qualityRate, 0, 100, 0, 9));
break;
case "image/gif":
imagegif($this->imageObject);
break;
case "image/webp":
imagewebp($this->imageObject);
break;
case "image/bmp":
imagebmp($this->imageObject);
break;
}
$base64_output = ob_get_contents();
ob_end_clean();
@@ -81,11 +87,17 @@ class CompressedImage
imagejpeg($this->imageObject, $filePath.".jpg", $this->qualityRate);
break;
case "image/png":
imagepng( $this->imageObject, $filePath.".png", self::mapValue($this->qualityRate, 0, 100, 0, 9));
imagepng($this->imageObject, $filePath.".png", self::mapValue($this->qualityRate, 0, 100, 0, 9));
break;
case "image/gif":
imagegif($this->imageObject, $filePath.".gif");
break;
case "image/webp":
imagewebp($this->imageObject, $filePath.".webp");
break;
case "image/bmp":
imagebmp($this->imageObject, $filePath.".bmp");
break;
}
}
+71 -51
View File
@@ -8,27 +8,43 @@
namespace geckon01\SimpleImageCompressor;
use geckon01\SimpleImageCompressor\Drivers\DriverInterface;
use geckon01\SimpleImageCompressor\Drivers\GdDriver;
/**
* Class SimpleImageCompressor
* @package geckon01\SimpleImageCompressor
*/
class SimpleImageCompressor
{
private const ALLOWED_IMAGE_FORMAT = "image/jpeg,image/png,image/gif";
private const ALLOWED_IMAGE_FORMAT = "image/jpeg,image/png,image/gif,image/webp,image/bmp";
private string $imageResourceUrl;
private string $imageData;
private string $imageType;
private int $approxMinimumHeight = 90;
private int $approxMinimumWidth = 90;
private bool $exifLoaded = false;
private ?DriverInterface $driver;
/**
* SimpleImageCompressor constructor.
* @param $url
* @param $url string url or path from where to load file
* @param DriverInterface|null $driver
*/
private function __construct($url)
private function __construct(string $url, ?DriverInterface $driver = null)
{
$this->imageResourceUrl = $url;
$this->exifLoaded = in_array("exif", get_loaded_extensions());
if($driver == null)
{
$this->driver = new GdDriver();
} else {
$this->driver = $driver;
}
}
/**
@@ -77,72 +93,76 @@ class SimpleImageCompressor
/**
* Determine current loaded image type
*/
private function loadImageType() {
$filetype = '';
private function loadImageType(string $imageBinary) {
$this->imageType = "image";
if (substr($this->imageData, 0, 2) === "\xFF\xD8") {
$filetype = 'image/jpeg';
} elseif (substr($this->imageData, 0, 3) === "\x89\x50\x4E") {
$filetype = 'image/png';
} elseif (substr($this->imageData, 0, 4) === "\x47\x49\x46\x38") {
$filetype = 'image/gif';
if($this->exifLoaded) {
switch (exif_imagetype($this->imageResourceUrl))
{
case IMAGETYPE_GIF:
$this->imageType = 'image/gif';
break;
case IMAGETYPE_JPEG:
$this->imageType = 'image/jpeg';
break;
case IMAGETYPE_PNG:
$this->imageType = 'image/png';
break;
case IMAGETYPE_BMP:
$this->imageType = 'image/bmp';
break;
case IMAGETYPE_WEBP:
$this->imageType = 'image/webp';
break;
case IMAGETYPE_ICO:
$this->imageType = 'image/ico';
break;
default:
break;
}
return;
}
// Fallback to bytes recognition
trigger_error("simple-image-compressor: Exif extension not found. Image MIME type recognition may be inaccurate.");
if (substr($imageBinary, 0, 2) === "\xFF\xD8") {
$this->imageType = 'image/jpeg';
}
if (substr($imageBinary, 0, 3) === "\x89\x50\x4E") {
$this->imageType = 'image/png';
}
if (substr($imageBinary, 0, 4) === "\x47\x49\x46\x38") {
$this->imageType = 'image/gif';
}
$this->imageType = $filetype;
}
/**
* Loading image from provided url. Whether it local file or internet resource
*/
private function readImageToString(): void {
$imageData = file_get_contents($this->imageResourceUrl);
$this->imageData = $imageData;
}
/**
* Resizes and compressing image.
* Note that gif compression not supported
* @param int $resolutionReductionPercent percent shows how much image resolution to original will be. The greater percent, the lower resolution
* @param int $reductionPercent percent shows how much image resolution to original will be. The greater percent, the lower resolution
* @param int $quality
* @return CompressedImage
* @throws \Exception
*/
public function resizeAndCompress($resolutionReductionPercent = 5, $quality = 90): CompressedImage
public function resizeAndCompress($reductionPercent = 5, $quality = 90): CompressedImage
{
$im = imagecreatefromstring($this->imageData);
$width = imagesx($im);
$height = imagesy($im);
$totalPixelCount = $width * $height;
$minimumPixelCount = $this->approxMinimumWidth * $this->approxMinimumHeight;
$maximumResolutionReductionPercent = round(abs(100 - ($minimumPixelCount / $totalPixelCount * 100)));
//Due to saving proportion we can't guarantee that width and height be equals max and min
//As example, if we have original image 1920*1080 which we want to get 50% of original resolution
//If we want to save 16*9 aspect ration it must be 960*540
//So, we override $maximumResolutionReductionPercent to value which satisfy origin aspect ratio
if($maximumResolutionReductionPercent < $resolutionReductionPercent)
$resolutionReductionPercent = $maximumResolutionReductionPercent;
$newWidth = round($width - ($width * $resolutionReductionPercent) / 100);
$newHeight = round($height - ($height * $resolutionReductionPercent) / 100);
$thumb = imagecreatetruecolor($newWidth, $newHeight);
imagecopyresized($thumb, $im, 0, 0, 0, 0, $newWidth, $newHeight, $width, $height);
return new CompressedImage($quality, $this->imageType,$thumb);
return $this->driver
->resize($reductionPercent, $quality, $this->approxMinimumWidth, $this->approxMinimumHeight, $this->imageType);
}
/**
* Initalize lib from provided image file path
* @param string $urlImageResource image resource path. Can be local file or internet URL
* @param DriverInterface|null $driver
* @return SimpleImageCompressor
* @throws \Exception
*/
public static function load(string $urlImageResource): SimpleImageCompressor
public static function load(string $urlImageResource, ?DriverInterface $driver = null): SimpleImageCompressor
{
$compressorObject = new SimpleImageCompressor($urlImageResource);
$compressorObject->readImageToString();
$compressorObject->loadImageType();
$compressorObject = new SimpleImageCompressor($urlImageResource, $driver);
$compressorObject->driver->load($urlImageResource);
$compressorObject->loadImageType($compressorObject->driver->getImageBinary());
if(!str_contains(self::ALLOWED_IMAGE_FORMAT, $compressorObject->getImageType())
|| $compressorObject->getImageType() === "")
@@ -150,4 +170,4 @@ class SimpleImageCompressor
return $compressorObject;
}
}
}
+14
View File
@@ -0,0 +1,14 @@
<?php
namespace geckon01\SimpleImageCompressor\Drivers;
use geckon01\SimpleImageCompressor\CompressedImage;
use geckon01\SimpleImageCompressor\SimpleImageCompressor;
interface DriverInterface
{
function resize(int $reductionPercent, int $quality, int $approxMinimumWidth, int $approxMinimumHeight, string $imageType): CompressedImage;
function load(string $path): DriverInterface;
function getImageBinary(): string;
}
+60
View File
@@ -0,0 +1,60 @@
<?php
namespace geckon01\SimpleImageCompressor\Drivers;
use geckon01\SimpleImageCompressor\CompressedImage;
class GdDriver implements DriverInterface
{
private string $imageData;
function resize(int $reductionPercent, int $quality, int $approxMinimumWidth, int $approxMinimumHeight, string $imageType): CompressedImage
{
$originImage = imagecreatefromstring($this->imageData);
if($originImage === false)
throw new \Exception("Can not read provided file");
$width = imagesx($originImage);
$height = imagesy($originImage);
$totalPixelCount = $width * $height;
$minimumPixelCount = $approxMinimumWidth * $approxMinimumHeight;
$maxReductionPercent = round(abs(100 - ($minimumPixelCount / $totalPixelCount * 100)));
// Due to saving proportion we can't guarantee that width and height be equals max and min
// As example, if we have original image 1920*1080 which we want to get 50% of original resolution
// If we want to save 16*9 aspect ration it must be 960*540
// So, we override $maxReductionPercent to value which satisfy origin aspect ratio
if($maxReductionPercent < $reductionPercent)
$reductionPercent = $maxReductionPercent;
$newWidth = round($width - ($width * $reductionPercent) / 100);
$newHeight = round($height - ($height * $reductionPercent) / 100);
$thumb = imagecreatetruecolor($newWidth, $newHeight);
imagecopyresized($thumb, $originImage, 0, 0, 0, 0, $newWidth, $newHeight, $width, $height);
return new CompressedImage($quality, $imageType, $thumb);
}
function load(string $path): DriverInterface
{
$this->imageData = file_get_contents($path);
if($this->imageData === false)
throw new \Exception("Cannot load image from provided resource: ".$path);
return $this;
}
function getImageBinary(): string
{
if($this->imageData == null)
throw new \Exception("Load image before getting its binary.");
return $this->imageData;
}
}