https://github.com/silencesoft/slim-image-resize
Image Resize Middleware for Slim Framework
https://github.com/silencesoft/slim-image-resize
Last synced: 6 months ago
JSON representation
Image Resize Middleware for Slim Framework
- Host: GitHub
- URL: https://github.com/silencesoft/slim-image-resize
- Owner: silencesoft
- License: mit
- Fork: true (tuupola/slim-image-resize)
- Created: 2019-01-11T02:13:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-12T23:28:09.000Z (over 7 years ago)
- Last Synced: 2025-08-15T20:53:39.430Z (11 months ago)
- Language: PHP
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Image Resize Middleware for Slim 3
### Note
*This is an update to original project tuupola/slim-image-resize to work with slim 3.*
This middleware implements automatic image resizing based on image filename.
[](https://twitter.com/tuupola)
[](LICENSE.txt)
[](https://travis-ci.org/tuupola/slim-image-resize)
[](http://hhvm.h4cc.de/package/tuupola/slim-image-resize)
[](https://codecov.io/github/tuupola/slim-image-resize)
## Install
You can install latest version using [composer](https://getcomposer.org/).
```
$ composer require tuupola/slim-image-resize @dev
```
## Configuration
Configuration options are passed as an array. There are no mandatory parameters.
```php
$app = new \Slim\Slim();
$app->add(new Slim\Middleware\ImageResize());
```
You can configure the allowed image extensions and cache folder. Cache folder must be writable by webserver process. Image quality applies only for jpg images. Example options shown below are also the default options used by the middleware.
```php
$app = new \Slim\Slim();
$app->add(new Slim\Middleware\ImageResize([
"extensions" => ["jpg", "jpeg", "png", "gif"],
"cache" => "cache",
"quality" => 90
]));
```
## Caching
For caching to work you also must add the following to your [.htaccess](https://github.com/tuupola/slim-image-resize/blob/master/example/.htaccess) file. These rules should be added before Slim rewrite rules. Folder name must be the same you passed in as middleware configuration option. With caching rewrite rules in place only first request is served by PHP. All subsequent requests are served with static file from cache folder.
```
# Check for cached image in cache folder.
RewriteCond %{REQUEST_METHOD} ^GET$
RewriteCond %{DOCUMENT_ROOT}/cache/%{REQUEST_URI} -f
RewriteRule ^(.*)$ /cache/$1 [L,QSA]
```
If your Slim application is installed in to a subfolder use the following rewrite rule instead. This example assumes the subfolder is called `example`.
```
RewriteBase /example
# Check for cached image in cache folder.
RewriteCond %{REQUEST_METHOD} ^GET$
RewriteCond %{DOCUMENT_ROOT}/example/cache/%{REQUEST_URI} -f
RewriteRule ^(.*)$ /example/cache/example/$1 [L,QSA]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [QSA,L]
```
## Usage
With middleware configured you can create different sizes of images by altering the filename.
```html
```
HTML above will produce the following images.
## Security
By default it is possible to create any size image. If images are also cached you should restrict which sizes middleware is allowed to create. Otherwise it is possible to make requests arbitary number of different sizes of images.
```php
$app = new \Slim\Slim();
$app->add(new Slim\Middleware\ImageResize([
"sizes" => ["400x200", "x200", "200x", "100x100"]
]));
```
If you have arbitary number of different sizes it is also possible to sign images with secret key.
```php
$app->add(new Slim\Middleware\ImageResize([
"secret" => "s11kr3t"
]));
```
You must include the signature in the image name.
```html
```
Signature for above image was generated with following code.
```php
$sha1 = sha1("400x200:s11kr3t");
$signature = substr($sha1, 0, 16);
```