wernerdweight/microbe-image-manager

Support for image resizing, cropping and encrypting for Microbe.

v2.0.0 2017-06-15 12:13 UTC

Requires

• php: >=7.0
• wernerdweight/image-manager: ~2.0

Suggests

• wernerdweight/microbe: ~1.0

MIT

• Werner Dweight

• image
• resize
• crop
• encrypt

README

This utility adds support for image resizing and cropping to Microbe.

Installation

1. Download using composer

	{
		"require": {
			"wernerdweight/microbe-image-manager": "~2.0"
		}
	}

1. Setup config

# app/config/microbe.yml
wd_image_manager:
	enabled: true
    upload_root: path/to/web/directory # public/uploads
    upload_path: relative/path/for/storing/images # e.g. images/image-manager
    secret: thisIsNotSecret # you can use app secret (%secret%) or any other custom secret (needed for encryption)
    versions:
        version_name_x:	# this key will be used as name of directory to where this version of images will be saved
            width: 200	# desired image width in pixels (if you ommit width or height image will keep its original dimensions)
            height: 200 # desired image height in pixels (if you ommit width or height image will keep its original dimensions)
            crop: true	# set this to true if you want the resulting image to have EXACTLY the dimensions specified (default false)
            watermark: # if you don't want your images to be watermarked, do not set this key at all
                file: absolute/path/to/watermark/file # e.g. %kernel.root_dir%/../web/watermark.png
                size: 50 # css-like watermark size; possible values: cover/contain/percentage (integer 0 - 100)
                position:
                    top: 50 # css-like position from top in percent (integer 0 - 100; default 100 - align to bottom)
                    left: 50 # css-like position from left in percent (integer 0- 100; default 100 - align to right)
        encrypted_version_name:
            encrypted: true	# if encrypted is set to true original image will be saved encrypted (intended for image download restrictions)
        ...
            

Usage

Code to be used inside a controller:

		/// get manager
		$im = $this->kernel->service('imageManager');
		
		/// upload your image file(s), create database records etc.
		...

		/// process image (one by one)
		/// 1st parameter ($file) is instance of WernerDweight\MicrobeImageManager\File\UploadedFile (mandatory)
		/// 2nd parameter is the filename of newly created file (mandatory)
		/// 3rd parameter is a path under upload_path from config (optional)
		$processedImageInfo = $im->processImage($file,'destination-filename','/optional/subpath');

License

This bundle is under the MIT license. See the complete license in the root directiory of the bundle.