jbouzekri/phumbor-bundle

A Symfony Bundle to use the minimal Thumbor PHP client from webfactory/phumbor

3.2.0 2024-04-26 16:44 UTC

Requires

• php: ^7.2|8.0.*|8.1.*|8.2.*|8.3.*
• symfony/config: ^3.4|^4.4|^5.0|^6.0|^7.0
• symfony/dependency-injection: ^3.4|^4.4|^5.0|^6.0|^7.0
• symfony/http-kernel: ^3.4|^4.4|^5.0|^6.0|^7.0
• twig/twig: ^1.34|^2.0|^3.0
• webfactory/phumbor: ^1.1

Requires (Dev)

• phpunit/phpunit: ^8.5.26|^9.5.20
• symfony/phpunit-bridge: >=6.0
• symfony/yaml: ^3.4|^4.4|^5.0|^6.0|^7.0

MIT

• symfony
• twig
• bundle
• helper
• thumbor
• phumbor

README

A Symfony Bundle to generate Thumbor image URLs, using the PHP client from webfactory.

Prerequisites

Of course, you must have a Thumbor server installed and operationnal. If not, you can follow the official installation documentation.

Installation

Add jbouzekri/phumbor-bundle as a dependency in composer.json.

"jbouzekri/phumbor-bundle": "^3.0"

Enable the bundle in your AppKernel :

$bundles = array(
    ...
    new Jb\Bundle\PhumborBundle\JbPhumborBundle()
);

In your config.yml, configure at least the url of your Thumbor server and the secret :

jb_phumbor:
    server:
        url: http://localhost
        secret: 123456789

Alternatively, you can also set the environment variables THUMBOR_URL and THUMBOR_SECURITY_KEY for these two settings, for example from your .env file or from inside your webserver configuration.

Quick use case

You need to resize the image of your article to fit in a square of 50x50. Define the following transformation in your config.yml :

jb_phumbor:
    transformations:
        article_list:
            fit_in: { width: 50, height: 50 }

Now you can use it in twig :

{{ thumbor(<the absolute url of your image>, 'article_list') }}

Documentation

• Configuration Reference
• Service
• Twig Helper

License

MIT - see LICENSE