Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ADmad/cakephp-glide
CakePHP plugin for using Glide image manipulation library
https://github.com/ADmad/cakephp-glide
cakephp cakephp-plugin image-processing middleware php thumbnail
Last synced: 3 months ago
JSON representation
CakePHP plugin for using Glide image manipulation library
- Host: GitHub
- URL: https://github.com/ADmad/cakephp-glide
- Owner: ADmad
- License: mit
- Created: 2015-08-14T06:49:04.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T12:39:23.000Z (5 months ago)
- Last Synced: 2024-03-09T23:25:06.571Z (4 months ago)
- Topics: cakephp, cakephp-plugin, image-processing, middleware, php, thumbnail
- Language: PHP
- Homepage:
- Size: 145 KB
- Stars: 34
- Watchers: 9
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Lists
- awesome-cakephp - ADmad/Glide plugin - A plugin for using [Glide](https://glide.thephpleague.com/) image manipulation library. (Imagery)
README
# CakePHP Glide
[](https://github.com/ADmad/cakephp-glide/actions?query=workflow%3ACI+branch%3Amaster)
[](https://codecov.io/github/ADmad/cakephp-glide)
[](https://packagist.org/packages/ADmad/cakephp-glide)
[](LICENSE.txt)
CakePHP plugin to help using [Glide](http://glide.thephpleague.com/) image manipulation library.
The plugin consists of a middlware, view helper and a Glide response class.
## Installation
Install the plugin through composer:
```
composer require admad/cakephp-glide
```
Load the plugin using CLI:
```sh
bin/cake plugin load ADmad/Glide
```
## Usage
### Middleware
In your `config/routes.php` setup the `GlideMiddleware` for required scope which
intercepts requests and serves images generated by Glide. For e.g.:
```php
$routes->scope('/images', function ($routes) {
$routes->registerMiddleware('glide', new \ADmad\Glide\Middleware\GlideMiddleware([
// Run this middleware only for URLs starting with specified string. Default null.
// Setting this option is required only if you want to setup the middleware
// in Application::middleware() instead of using router's scoped middleware.
// It would normally be set to same value as that of server.base_url below.
'path' => null,
// Either a callable which returns an instance of League\Glide\Server
// or config array to be used to create server instance.
// http://glide.thephpleague.com/1.0/config/setup/
'server' => [
// Path or League\Flysystem adapter instance to read images from.
// http://glide.thephpleague.com/1.0/config/source-and-cache/
'source' => WWW_ROOT . 'uploads',
// Path or League\Flysystem adapter instance to write cached images to.
'cache' => WWW_ROOT . 'cache',
// URL part to be omitted from source path. Defaults to "/images/"
// http://glide.thephpleague.com/1.0/config/source-and-cache/#set-a-base-url
'base_url' => '/images/',
// Response class for serving images. If unset (default) an instance of
// \ADmad\Glide\Response\PsrResponseFactory() will be used.
// http://glide.thephpleague.com/1.0/config/responses/
'response' => null,
],
// http://glide.thephpleague.com/1.0/config/security/
'security' => [
// Boolean indicating whether secure URLs should be used to prevent URL
// parameter manipulation. Default false.
'secureUrls' => false,
// Signing key used to generate / validate URLs if `secureUrls` is `true`.
// If unset value of Cake\Utility\Security::salt() will be used.
'signKey' => null,
],
// Cache duration. Default '+1 days'.
'cacheTime' => '+1 days',
// Any response headers you may want to set. Default null.
'headers' => [
'X-Custom' => 'some-value',
],
// Allowed query string params. If for e.g. you are only using glide presets
// then you can set allowed params as `['p']` to prevent users from using
// any other image manipulation params.
'allowedParams' => null
]));
$routes->applyMiddleware('glide');
$routes->connect('/*');
});
```
For the example config shown above, for URL like `domain.com/images/user/profile.jpg`
the source image should be under `webroot/uploads/user/profile.jpg`.
__Note__: Make sure the image URL does not directly map to image under webroot.
Otherwise as per CakePHP's default URL rewriting rules the image will be served by
webserver itself and request won't reach your CakePHP app.
#### Exceptions
If you have enabled secure URLs and a valid token is not present in query string
the middleware will throw a `ADmad\Glide\Exception\SignatureException` exception.
If a response image could not be generated by the Glide library then by default
the middleware will throw a `ADmad\Glide\Exception\ResponseException`.
A `Glide.response_failure` event will also be triggered in this case. You can setup a
listener for this event and return a response instance from it. In this case
that response will be sent to client and `ResponseException` will not be thrown.
```php
\Cake\Event\EventManager::instance()->on(
\ADmad\Glide\Middleware\GlideMiddleware::RESPONSE_FAILURE_EVENT,
function ($event) {
return (new Response())
->withFile('/path/to/default-image.jpg');
}
);
```
### Helper
The provided `GlideHelper` helps creating URLs and image tags for generating
images. You can load the helper in your `AppView::initialize()` as shown in
example below:
```php
public function initialize(): void
{
// All option values should match the corresponding options for `GlideFilter`.
$this->loadHelper('ADmad/Glide.Glide', [
// Base URL.
'baseUrl' => '/images/',
// Whether to generate secure URLs.
'secureUrls' => false,
// Signing key to use when generating secure URLs.
'signKey' => null,
]);
}
```
Here are the available methods of `GlideHelper`:
```php
/**
* Creates a formatted IMG element.
*
* @param string $path Image path.
* @param array $params Image manipulation parameters.
* @param array $options Array of HTML attributes and options.
* See `$options` argument of `Cake\View\HtmlHelper::image()`.
* @return string Complete ![]()
tag.
*/
GlideHelper::image(string $path, array $params = [], array $options = []): string
/**
* URL with query string based on resizing params.
*
* @param string $path Image path.
* @param array $params Image manipulation parameters.
* @return string Image URL.
*/
GlideHelper::url(string $path, array $params = []): string
```
The main benefit of using this helper is depending on the value of `secureUrls`
config, the generated URLs will contain a token which will be verified by the
middleware. The prevents modification of query string params.