category

Environment Label プラグインで管理画面に環境ごとのラベルを表示させてミスを減らす #craftcms

2019-12-13

Environment Label という環境ごとのラベルを表示できるプラグインがあったので試してみた。

Environment Label
https://plugins.craftcms.com/e...

環境ごとに表示させるテキストとか色をかえることで、今どの環境のCMSを触っているのか？がわかりやすくなるというもの。

MTAppjQuery でも同じ案件で複数環境がある時とかよくこういうカスタマイズをして、ヘッダの色をかえるとかはやったりする。

プラグインのインストール

プラグインをインストールする。

$ composer require topshelfcraft/environment-label

$ ./craft install/plugin environment-label

インストールするとこのような感じで、ヘッダに dev とラベルが表示される

この文言や色は管理画面からも設定ができる。

env ファイルで設定を管理する

環境ごとに設定するわけなので、設定自体を env ファイルに書いておいてそれを利用すると言うこともできる。

config/environment-label.php とファイルを用意する。

<?php
return [
    'showLabel' => getenv('CRAFT_ENV_SHOW_LABEL'),
    'labelText' => getenv('CRAFT_ENV_LABEL_TEXT'),
    'labelColor' => getenv('CRAFT_ENV_LABEL_COLOR'),
];

そのうえで env ファイルに設定内容を追記する。

CRAFT_ENV_SHOW_LABEL="true"
CRAFT_ENV_LABEL_TEXT="envで設定したテキスト"
CRAFT_ENV_LABEL_COLOR="#000000"

設定が反映された。

ちょっとしたことではあるけれど、こういうプラグインをつかったり、他のプラグインとかで環境の間違いが起こらないようにしておくのも1つだと思う。

事故が起こっちゃってからでは取り返しがつかないし。