Enable.php 3.7 KB
Newer Older
Indra Raja's avatar
Indra Raja committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
<?php
/**
 * @link      http://github.com/zfcampus/zf-development-mode for the canonical source repository
 * @copyright Copyright (c) 2014-2016 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

namespace ZF\DevelopmentMode;

use RuntimeException;

class Enable
{
    use ConfigDiscoveryTrait;

    const DEVEL_CONFIG      = 'config/development.config.php';
    const DEVEL_CONFIG_DIST = 'config/development.config.php.dist';
    const DEVEL_LOCAL       = 'config/autoload/development.local.php';
    const DEVEL_LOCAL_DIST  = 'config/autoload/development.local.php.dist';

    /**
     * @var resource
     */
    private $errorStream;

    /**
     * @param string Path to project.
     */
    private $projectDir;

    /**
     * @param string $projectDir Location to resolve project from.
     * @param null|resource $errorStream Stream to which to write errors; defaults to STDERR
     */
    public function __construct($projectDir = '', $errorStream = null)
    {
        $this->projectDir = $projectDir;
        $this->errorStream = is_resource($errorStream) ? $errorStream : STDERR;
    }

    /**
     * Enable development mode.
     *
     * @return int
     */
    public function __invoke()
    {
        $develConfig = $this->projectDir
            ? sprintf('%s/%s', $this->projectDir, self::DEVEL_CONFIG)
            : self::DEVEL_CONFIG;
        if (file_exists($develConfig)) {
            // nothing to do
            echo 'Already in development mode!', PHP_EOL;
            return 0;
        }

        $develConfigDist = $this->projectDir
            ? sprintf('%s/%s', $this->projectDir, self::DEVEL_CONFIG_DIST)
            : self::DEVEL_CONFIG_DIST;
        if (! file_exists($develConfigDist)) {
            fwrite(
                $this->errorStream,
                'MISSING "config/development.config.php.dist". Could not switch to development mode!' . PHP_EOL
            );
            return 1;
        }

        try {
            $this->removeConfigCacheFile();
        } catch (RuntimeException $ex) {
            fwrite($this->errorStream, $ex->getMessage());
            return 1;
        }

        $this->copy($develConfigDist, $develConfig);

        $develLocalDist = $this->projectDir
            ? sprintf('%s/%s', $this->projectDir, self::DEVEL_LOCAL_DIST)
            : self::DEVEL_LOCAL_DIST;
        if (file_exists($develLocalDist)) {
            // optional application config override
            $develLocal = $this->projectDir
                ? sprintf('%s/%s', $this->projectDir, self::DEVEL_LOCAL)
                : self::DEVEL_LOCAL;
            $this->copy($develLocalDist, $develLocal);
        }

        echo 'You are now in development mode.', PHP_EOL;
        return 0;
    }

    /**
     * Returns whether the OS support symlinks reliably.
     *
     * This approach uses a pre-configured whitelist of PHP_OS values that
     * typically support symlinks reliably. This may omit some systems that
     * also support symlinks properly; if you find this to be the case, please
     * send a pull request with the PHP_OS value for us to match.
     *
     * This method is marked protected so that we can mock it.
     *
     * @return bool
     */
    protected function supportsSymlinks()
    {
        return in_array(PHP_OS, ['Linux', 'Unix', 'Darwin']);
    }

    /**
     * Copy, or symlink, the source to the destination.
     *
     * @param string $source
     * @param string $destination
     * @return void
     */
    private function copy($source, $destination)
    {
        if ($this->supportsSymlinks()) {
            symlink(basename($source), $destination);
            return;
        }

        copy($source, $destination);
    }
}