Configuration Application Modes

Application Modes

It is common practice to run web applications in a specific mode depending on the current state of the project. If you are developing the application, you will run the application in “development” mode; if you are testing the application, you will run the application in “staging” mode; if you launch the application, you will run the application in “production” mode.

Yee supports the concept of modes in that you may define your own modes and prompt Yee to prepare itself appropriately for the current mode. For example, you may want to enable debugging in “development” mode but not in “production” mode. The examples below demonstrate how to configure Yee differently for a given mode.

What is a mode?

Technically, an application mode is merely a string of text - like “development” or “production” - that has an associated callback function used to prepare the Yee application appropriately. The application mode may be anything you like: “staging”, “production”, “development”, or even “foo”.

How do I set the application mode?

Use an environment variable

If Yee sees an environment variable named "YEE_MODE", it will set the application mode to that variable’s value.

<?php
$_ENV['YEE_MODE'] = 'production';

Use application setting

If an environment variable is not found, Yee will next look for the mode in the application settings.

<?php
$app = new \Yee\Yee(array(
    'mode' => 'production'
));

Default mode

If the environment variable and application setting are not found, Yee will set the application mode to “development”.

Configure for a Specific Mode

After you instantiate a Yee application, you may configure the Yee application for a specific mode with the Yee application's configureMode() method. This method accepts two arguments: the name of the target mode and a callable function to be immediately invoked if the first argument matches the current application mode.

Assume the current application mode is “production”. Only the callable associated with the “production” mode will be invoked. The callable associated with the “development” mode will be ignored until the application mode is changed to “development”.

<?php
// Set the current mode
$app = new \Yee\Yee(array(
    'mode' => 'production'
));

// Only invoked if mode is "production"
$app->configureMode('production', function () use ($app) {
    $app->config(array(
        'log.enable' => true,
        'debug' => false
    ));
});

// Only invoked if mode is "development"
$app->configureMode('development', function () use ($app) {
    $app->config(array(
        'log.enable' => false,
        'debug' => true
    ));
});