Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Composer script handling your ignored parameter file
PHP
branch: patch-1

This branch is 84 commits behind Incenteev:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.gitignore
LICENSE
README.md
ScriptHandler.php
composer.json

README.md

Managing your ignored parameters with Composer

This tool allows you to manage your ignored parameters when running a composer install or update. It works when storing the parameters in a Yaml file under a parameters key.

Usage

In your root composer.json, adds the following:

{
    "require": {
        "logsafe/composer-parameter-handler": "1.0.*"
    },
    "scripts": {
        "post-install-cmd": [
            "LogSafe\\ParameterHandler\\ScriptHandler::buildParameters"
        ],
        "post-update-cmd": [
            "LogSafe\\ParameterHandler\\ScriptHandler::buildParameters"
        ]
    },
    "extra": {
        "logsafe-parameters": {
            "file": "app/config/parameters.yml"
        }
    }
}

The app/config/parameters.yml will then be created or updated by the composer script, to match the structure of the dist file app/config/parameters.yml.dist by asking you the missing parameters.

By default, the dist file is assumed to be in the same place than the parameters file, suffixed by .dist. This can be changed in the configuration:

{
    "extra": {
        "logsafe-parameters": {
            "file": "app/config/parameters.yml",
            "dist-file": "app/config/parameters.dist.yml"
        }
    }
}

The script handler will ask you interactively for parameters which are missing in the parameters file, using the value of the dist file as default value. All prompted values are parsed as inline Yaml, to allow you to define true, false, null or numbers easily. If composer is run in a non-interactive mode, the values of the dist file will be used for missing parameters.

Using environment variables to set the parameters

For your prod environment, using an interactive prompt may not be possible when deploying. In this case, you can rely on environment variables to provide the parameters. This is achieved by providing a map between environment variables and the parameters they should fill:

{
    "extra": {
        "logsafe-parameters": {
            "env-map": {
                "MY_FIRST_PARAM": "my_first_param",
                "MY_SECOND_PARAM": "my_second_param"
            }
        }
    }
}

If an environment variable is set, its value will always replace the value set in the existing parameters file.

As environment variables can only be strings, they are also parsed as inline YAML values to allows specifying null, false, true or numbers easily.

Something went wrong with that request. Please try again.