zfcampus/zf-development-mode

ZF2 development mode module

Installs: 112 469

Dependents: 8

Stars: 14

Watchers: 5

Forks: 20

Language: PHP

2.1.0 2015-07-15 16:37 UTC

README

This ZF2 "development mode" module allows you to specify configuration and modules that should only be enabled when in development, and not when in production.

Requirements

Please see the composer.json file.

Installation with Composer

  1. Add "zfcampus/zf-development-mode": "2.*" to the "require" section your composer.json file and run php composer.phar update.
  2. Copy development.config.php.dist to your application's config/ directory, without renaming the file, and edit as required. Commit this file to your version control system. Optionally, if you want to override application config as well, copy development.local.php.dist file into config/autoload/ and update it.
  3. Add any development modules to the "require-dev" section of your application's composer.json. e.g:

        "zendframework/zend-developer-tools": "dev-master",
        "zendframework/zftool": "dev-master"

    and run composer.update.

  4. If you're using Zend Developer Tools, Copy ./vendor/zendframework/zend-developer-tools/config/zenddevelopertools.local.php.dist to ./config/autoload/zenddevelopertools.local.php. Change any settings in it according to your needs.
  5. Add 'ZF\DevelopmentMode' to the list of Modules in your application's config/application.config.php file.
  6. In your application's public/index.php, replace these lines:

        // Run the application!
        Zend\Mvc\Application::init(require 'config/application.config.php')->run();

    with

        // Config
        $appConfig = include 'config/application.config.php';
    
        if (file_exists('config/development.config.php')) {
            $appConfig = Zend\Stdlib\ArrayUtils::merge($appConfig, include 'config/development.config.php');
        }
    
        // Run the application!
        Zend\Mvc\Application::init($appConfig)->run();

To enable development mode

cd path/to/install
php public/index.php development enable

Note: enabling development mode will also clear your module configuation cache, to allow safely updating dependencies and ensuring any new configuration is picked up by your application.

To disable development mode

cd path/to/install
php public/index.php development disable

Note: Don't run development mode on your production server.