Download the PHP package spacecatninja/imager-x-imageboss-transformer without Composer
On this page you can find all versions of the php package spacecatninja/imager-x-imageboss-transformer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spacecatninja/imager-x-imageboss-transformer
More information about spacecatninja/imager-x-imageboss-transformer
Files in spacecatninja/imager-x-imageboss-transformer
Package imager-x-imageboss-transformer
Short Description ImageBoss transformer for Imager X
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package imager-x-imageboss-transformer
ImageBoss transformer for Imager X
A plugin for using ImageBoss as a transformer in Imager X.
Also, an example of how to make a custom transformer for Imager X.
Requirements
This plugin requires Craft CMS 5.0.0-beta.1 or later, Imager X 5.0.0-beta.1 or later, and an account at ImageBoss.
Usage
Install and configure this transformer as described below. Then, in your Imager X config,
set the transformer to imageboss, ie:
Transforms are now by default transformed with ImageBoss, test your configuration with a simple transform like this:
If this doesn't work, make sure you've configured a defaultProfile, have a profile with the correct name, and
that the source is set up to use the same buckets that you assets are on.
Cave-ats, shortcomings, and tips
This transformer only supports a subset of what Imager X can do when using the default craft transformer.
All the basic transform parameters are supported, with the following exceptions:
- Only assets can be transformed. If you need to transform external images, you need to switch to the
crafttransformer for those transforms. - The
cropOnlyandstretchresize modes are not supported. - Opacity for colors on
letterboxresize mode is not supported. - Only the following
effectsare converted and supported:grayscale,sharpen,blurandgamma. – Watermarks are not translated automatically from Imager syntax to ImageBoss', but you can still add watermarks by manually passing them through theoptionsobject (see below).
To pass additional options directly to ImageBoss, you can use the transformerParams transform parameter and pass them in using an options object. Example:
For more information, check out the ImageBoss documentation.
Installation
To install the plugin, follow these instructions:
- Install with composer via
composer require spacecatninja/imager-x-imageboss-transformerfrom your project directory. - Install the plugin in the Craft Control Panel under Settings > Plugins, or from the command line via
./craft plugin/install imager-x-imageboss-transformer.
Configuration
You can configure the transformer by creating a file in your config folder called
imager-x-imageboss-transformer.php, and override settings as needed.
profiles [array]
Default: []
Profiles are usually a one-to-one mapping to the image sources you've created in ImageBoss.
Which in turn will often map to a Volume in your Craft setup. You set the default profile to use using the defaultProfile config
setting, and can override it at the template level by setting profile in your transformerParams.
Example profile:
Each profile takes three settings:
sourceName: This is the "Source Name" you selected in ImageBoss.
signToken: If you've enabled signed URL's for security, add your sign token here.
useCloudSourcePath: If enabled, Imager will prepend the Craft source path to the asset path, before adding it to the ImageBoss URL. This makes it possible to have one ImageBoss source pulling images from many Craft volumes when they are for instance on the same S3 bucket, but in different subfolder. This only works on volumes that implements a path setting (AWS S3 and GCS does, local volumes does not).
defaultProfile [string]
Default: ''
Sets the default profile to use (see profiles). You can override profile at the transform level by setting it through the transformParams transform parameter. Example:
enableCompression [bool]
Default: true
Set to falseto disable ImageBoss' default auto compression that delivers WebP automatically when the browser supports it.
enableProgressive [bool]
Default: true
Set to falseto disable ImageBoss' default behavior that delivers progressive JPEG's when possible.
enableAutoRotate [bool]
Default: true
Set to falseto disable ImageBoss' default behavior that uses EXIF data in the image to auto rotate it.
Price, license and support
The plugin is released under the MIT license. It requires Imager X, which is a commercial plugin available in the Craft plugin store. If you need help, or found a bug, please post an issue in this repo, or in Imager X' repo (preferably).
