Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/folkloreinc/laravel-image
https://github.com/folkloreinc/laravel-image
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/folkloreinc/laravel-image
- Owner: folkloreinc
- Created: 2021-04-14T18:23:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T16:34:53.000Z (6 months ago)
- Last Synced: 2024-10-10T20:54:03.182Z (3 months ago)
- Language: PHP
- Size: 152 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Laravel Image
Laravel Image is an image manipulation package for Laravel 4 and 5 based on the [PHP Imagine library](https://github.com/avalanche123/Imagine). It is inspired by [Croppa](https://github.com/BKWLD/croppa) as it can use specially formatted urls to do the manipulations. It supports basic image manipulations such as resize, crop, rotation, flip and effects such as negative, grayscale, gamma, colorize and blur. You can also define custom filters for greater flexibility. This library works with the local filesystem and Laravel Filesystems (Amazon S3, etc...).
[](https://packagist.org/packages/folklore/laravel-image)
[](https://travis-ci.org/Folkloreatelier/laravel-image)
[](https://coveralls.io/github/Folkloreatelier/laravel-image?branch=v1)
[](https://packagist.org/packages/folklore/laravel-image)
## Introduction
The main difference between this package and other image manipulation libraries is that you can use parameters directly in the url to manipulate the image. A manipulated version of the image is then saved in the same path as the original image, **creating a static version of the file and bypassing Laravel for future requests** (this behaviour can be disabled).
For example, if you have an image at this URL:
```
/uploads/photo.jpg
```
To create a 300x300 version of this image in black and white, you use the URL:
```
/uploads/photo-image(300x300-crop-grayscale).jpg
```
To help you generate the URL to an image, you can use the `Image::url()` method
```php
Image::url('/uploads/photo.jpg', 300, 300, ['crop', 'grayscale']);
```
or
```php
)?>)
```
Alternatively, you can programmatically manipulate images using the `Image::make()` method. It supports all the same options as the `Image::url()` method.
```php
Image::make('/uploads/photo.jpg', [
'width' => 300,
'height' => 300,
'grayscale' => true
])->save('/path/to/the/thumbnail.jpg');
```
or use directly the Imagine library
```php
$thumbnail = Image::open('/uploads/photo.jpg')
->thumbnail(new Imagine\Image\Box(300, 300));
$thumbnail->effects()->grayscale();
$thumbnail->save('/path/to/the/thumbnail.jpg');
```
## Features
#### Based on Imagine
This package use [Imagine](https://github.com/avalanche123/Imagine) for image manipulation. Imagine is compatible with GD2, Imagick, Gmagick and supports a lot of [features](http://imagine.readthedocs.org/en/latest/).
#### Multiple Sources
You can define multiple sources for your images. Both locally and in the cloud (via Laravel filesystems).
#### Filters
This package also provides some build-in filters ready to use \([more on Filters](docs/filters.md)\):
* Resize
* Crop \(with position\)
* Rotation
* Black and white
* Invert
* Gamma
* Blur
* Colorization
* Interlace
## Installation
##### Version Compatibility
Laravel 7 and up
#### Dependencies:
* [Laravel 7.x|8.x](https://github.com/laravel/laravel)
* [Imagine 1.x](https://github.com/avalanche123/Imagine)
#### Server Requirements:
* [gd](http://php.net/manual/en/book.image.php) or [Imagick](http://php.net/manual/fr/book.imagick.php) or [Gmagick](http://www.php.net/manual/fr/book.gmagick.php)
* [exif](http://php.net/manual/en/book.exif.php) - Required to get image format.
#### Installation:
**1-** Require the package via Composer.
```json
$ composer require folklore/laravel-image
```
**2-** Add the service provider to your `app/config/app.php` file
```php
Folklore\Image\ServiceProvider::class,
```
**3-** Add the facade to your `app/config/app.php` file
```php
'Image' => Folklore\Image\Facade::class,
```
**4-** Publish the configuration file and public files
```bash
$ php artisan vendor:publish --provider="Folklore\Image\ServiceProvider"
```
**5-** Review the configuration file at `config/image.php`
## Documentation
* [Complete documentation](https://folkloreatelier.gitbooks.io/laravel-image/)
## Roadmap
Here are some features we would like to add in the future. Feel free to collaborate and improve this library.
* Artisan command to manipulate images
* Support for batch operations on multiple files