Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/armin-runggaldier/croppy
PHP Framework for image manipulation
https://github.com/armin-runggaldier/croppy
composer crop crop-image image manipulation php resize resize-images
Last synced: about 2 months ago
JSON representation
PHP Framework for image manipulation
- Host: GitHub
- URL: https://github.com/armin-runggaldier/croppy
- Owner: armin-runggaldier
- License: mit
- Created: 2020-07-24T21:31:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T11:15:08.000Z (about 2 years ago)
- Last Synced: 2024-10-31T06:51:38.503Z (2 months ago)
- Topics: composer, crop, crop-image, image, manipulation, php, resize, resize-images
- Language: PHP
- Homepage: https://armin-runggaldier.github.io/croppy/
- Size: 10.9 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Croppy - PHP Framework for image manipulation
Version: 1.3
PHP Version: php >= 8.0
## Features
- image resize
- image crop
- extend image area
- image conversion
- supported formats: .jpeg, .jpg, .png, .gif, .webp
- image quality management
- image save to filesystem or output
- designed for PHP >= 8.1
## Installation
Croppy is actually available trough [Composer](https://getcomposer.org) (recommended) or direct download.
To use [Composer](https://getcomposer.org), just add this line to your `composer.json` file:
```json
"croppy/croppy": "~1.1"
```
and run the follow command:
```sh
composer install
```
You can also run the follow command in the terminal (you must be in the project directory):
```sh
composer require croppy/croppy
```
## Usage
**Basic usage:**
```php
use Croppy\Croppy\Croppy;
use Croppy\Croppy\Exception;
require 'path/to/src/Croppy.php';
require 'path/to/src/Exception.php';
$croppy = new Croppy();
$croppy->setSourcePath(__DIR__.'/path/to/image.jpg');
$croppy->setJpegQuality(60);
$croppy->resize(700, 700, false); // width, height, crop
$croppy->save(__DIR__.'/path/to/destination.jpg');
```
**Resize, crop and output:**
```php
use Croppy\Croppy\Croppy;
use Croppy\Croppy\Exception;
require 'path/to/src/Croppy.php';
require 'path/to/src/Exception.php';
$croppy = new Croppy();
$croppy->setSourcePath(__DIR__.'/path/to/image.png');
$croppy->setPngCompression(6);
// set crop position x, y
$croppy->setCropPosition($croppy::CROPCENTER, $croppy::CROPSTART); // $croppy::CROPSTART | $croppy::CROPCENTER | $croppy::CROPEND
// set background color
$croppy->setBackground(255, 255, 255, 100); // R, G, B, opacity
$croppy->resize(700, 700, true); // width, height, crop
$croppy->output();
// get path of input file
echo $croppy->getSourcePath();
```
## Documentation
**setSourcePath** `(string $sourcePath) : void`
Defines the path of the source image, can be relative or absolute
**setJpegQuality** `(int $quality = 80) : void`
Defines quality for JPEG images (0 - 100), 100 best quality
**setWebpQuality** `(int $quality = 80) : void`
Defines quality for WEBP images (0 - 100), 100 best quality
**setPngCompression** `(int $compression = 6) : void`
Defines quality for PNG images (0 - 9), 0 means no compression
**setUpScaleAllowed** `(bool $upScaleAllowed = false) : void`
Deinfes if images should be scaled up (distort image), default is false
**getSourcePath** `() : string`
Returns the path to the source image. It could return a relative or absolute path (depends on input)
**setCropPosition** `($cropAlignmentX = Croppy::CROPCENTER, $cropAlignmentY = Croppy::CROPCENTER) : void`
Defines the crop position of the image. `$crop` flag must be set to true.
$cropAlignmentX defines the horizontal alignment, $cropAlignmentY defines the vertical alignment. Possible values: Croppy::CROPSTART, Croppy::CROPCENTER, Croppy::CROPEND
**setBackground** `($backgroundColorR, $backgroundColorB, $backgroundColorG, $opacity = 100) : void`
Set background color, which is always set in `resize` and `extend` method. Actually Croppy only supports RGB. `$opacity` defines the opacity of the background color (100 is complete transparent).
**resize** `(float $destinationWidth, float $destinationHeight, bool $crop = false) : bool`
Resize image to the given `$destinationWidth` and `$destinationHeight`. If `$crop` is set to true, the image will be cropped. If `$crop` is set to false, the image will be adjusted (max width and max height).
**extend** `(float $destinationWidth, float $destinationHeight) : bool`
Extends image area and fill background with `$backgroundColor`. Could also used for crop image without resize.
**save** `($destinationPath, $convertType = false) : bool`
Writes the generated image to the defined `$destinationPath`.
`$convertType` enables the conversion of the image type. The destination image type will be identify from the filename in `$destinationPath` (ex. path/to/image.webp will convert the image to WEBP). Return true on success or false on failure.
**output** `($convertType = false) : void`
Streams the image direct to output and set `Content-Type` header.
`$convertType` enables the conversion of the image type. The destination image type will be identify from the filename in `$destinationPath` (ex. path/to/image.webp will convert the image to WEBP). Return true on success or false on failure.
## Planned features for further releases:
- image ratio resize
## Changelog version 1.3 (15.11.2022):
- Support for PHP Version 8
- minor bugfixes for `$upScaleAllowed` property
## Changelog version 1.2 (31.12.2020):
- image upscale definiton
- extend image area and fill with background color
- image type conversion (for example .png to .jpg)
## Changelog version 1.1 (19.09.2020):
- image quality settings (jpeg, png and webp)
If you are missing a feature, please create a pull request :)
Made with ❤ in _South Tyrol_ by **Armin Runggaldier**