basilicom/pimcore-plugin-system-banner

Shows a banner of the pimcore environment, to indicate if you are on prod or dev or else.

v2.0.2 2024-01-15 14:01 UTC

Requires

• php: >=8.0
• pimcore/pimcore: >=10

MIT

• Kerstin Gerull
• Fabian Fischer

README

This plugin will show a banner on the top right with the environment name.

• development environments = green
• test environments = purple
• stage environments = yellow
• prod environments = red

it is used the .env variable APP_ENV.

Version information

Bundle Version	PHP	Pimcore
< 2.0	^7.3	^6.0
>= 2.0	^8.0	^10.0

Installation

composer require basilicom/pimcore-plugin-system-banner

Activate Plugin

• Add to \App\Kernel.php

public function registerBundlesToCollection(BundleCollection $collection)
{
    // ...
    $collection->addBundle(new PimcorePluginSystemBannerBundle());
    // ...
}

or

• Activate in the Pimcore backend in Tools -> Bundles & Bricks

build assets

for Pimcore X respectively Symfony 5

bin/console assets:install public --symlink --relative

for lower than Pimcore X respectively lower than Symfony 5

bin/console assets:install web --symlink --relative

Add the banner to the frontend

It will only show the banner when a backend user is active.

use the following twig function

{{ renderSystemBanner() | raw }}

customize the env name and color

You can customize the display of the name in the .env file (or .env.local). Use the following variable:

SYSTEM_BANNER_TEXT="My env name"

To customize the color, you can use the following variable:

SYSTEM_BANNER_COLOR=purple

you can choose between:

• green
• yellow
• red
• purple
• blue