babeuloula/cloud-image-proxy

A proxy between your application and CloudImage

0.6.1 2024-10-29 06:20 UTC

Requires

• php: >=8.1
• symfony/cache: ^6.0|^7.0
• symfony/config: ^6.0|^7.0
• symfony/dependency-injection: ^6.0|^7.0
• symfony/filesystem: ^6.0|^7.0
• symfony/http-client: ^6.0|^7.0
• symfony/http-foundation: ^6.0|^7.0
• symfony/http-kernel: ^6.0|^7.0
• symfony/routing: ^6.0|^7.0
• twig/twig: ^3.0

Requires (Dev)

• babeuloula/phpcs: ^1.5
• intervention/image: ^3.9
• phpstan/phpstan: ^1.12
• phpstan/phpstan-deprecation-rules: ^1.2
• phpstan/phpstan-strict-rules: ^1.6
• phpstan/phpstan-symfony: ^1.4

Suggests

• intervention/image: Needed to use InterventionImageFallback.

MIT

• BaBeuloula

README

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require babeuloula/cloud-image-proxy

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    BaBeuloula\CloudImageProxy\CloudImageProxyBundle::class => ['all' => true],
];

Step 3: Configure the Bundle

# config/packages/cloud_image_proxy.yaml

cloud_image_proxy:
    proxy:
        assets_path: 'mandatory'
        url: 'mandatory'
        check_assets: true # if the bundle need to check if you have the file on the server before fetch from CloudImage
        encrypted_parameters: false # if you need to hide the query parameters on your application
    encrypter:
        secret_key: null # the key encrypting and decrypting the query parameters (required if proxy.encrypted_parameters is true)
    twig:
        route_name: 'mandatory' # the route to the controller that displays the assets
        route_parameter: 'mandatory' # the route parameter name

Using a fallback handler

If you don't have access to CloudImage or if you want to use it on local development, you can set up a fallback handler.

Actually, I only support Intervention Image v3.

Intervention\Image\Drivers\Imagick\Driver: ~

BaBeuloula\CloudImageProxy\FallbackHandler\InterventionImageFallbackHandler:
    arguments:
        $assetsPath: '_your_path_'
        $driver: '@Intervention\Image\Drivers\Imagick\Driver'
        $cache: '_your_cache_instance_'

BaBeuloula\CloudImageProxy\FallbackHandler\FallbackHandlerInterface: '@BaBeuloula\CloudImageProxy\FallbackHandler\InterventionImageFallbackHandler'

Contributing

Build and install dependencies

You can use the existing docker stack with the command make install to build the Dockerfile and install the composer dependencies.

If you want to execute some commands through Docker, just use docker/exec your_command.

Run testing stack

# Run all tests
make check

# Execute PHPCS
make lint

# Execute PHPCS fixer
make fixer

# Execute PHPStan
make analyse