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: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license  https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Environment;

trait PropsGettersSetters {

    /**
     * If `TRUE` (by default), environment will be detected by loaded system config.
     * @var boolean
     */
    protected static $detectionBySystemConfig = TRUE;

    /**
     * Reference to singleton instance in `\MvcCore\Application::GetInstance();`.
     * @var \MvcCore\Application
     */
    protected static $app;

    /**
     * Environment name. Usual values:
     * - `"dev"`            - Development environment.
     * - `"beta"`           - Common team testing environment.
     * - `"alpha"`          - Release testing environment.
     * - `"production"`     - Release environment.
     * @var string|NULL
     */
    protected $name = NULL;

    /**
     * Boolean values for all detected environments.
     * @var array
     */
    protected $values = [];


    /**
     * @inheritDocs
     * @return \string[]
     */
    public static function GetAllNames () {
        return [
            \MvcCore\IEnvironment::DEVELOPMENT,
            \MvcCore\IEnvironment::ALPHA,
            \MvcCore\IEnvironment::BETA,
            \MvcCore\IEnvironment::PRODUCTION
        ];
    }

    /**
     * @inheritDocs
     * @param boolean $detectionBySystemConfig `TRUE` by default.
     * @return boolean
     */
    public static function SetDetectionBySystemConfig ($detectionBySystemConfig = TRUE) {
        return static::$detectionBySystemConfig = $detectionBySystemConfig;
    }

    /**
     * @inheritDocs
     * @return boolean
     */
    public static function GetDetectionBySystemConfig () {
        return static::$detectionBySystemConfig;
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsDevelopment () {
        /** @var $this \MvcCore\Environment */
        if ($this->name === NULL) $this->GetName();
        return $this->values[\MvcCore\IEnvironment::DEVELOPMENT];
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsBeta () {
        /** @var $this \MvcCore\Environment */
        if ($this->name === NULL) $this->GetName();
        return $this->values[\MvcCore\IEnvironment::BETA];
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsAlpha () {
        /** @var $this \MvcCore\Environment */
        if ($this->name === NULL) $this->GetName();
        return $this->values[\MvcCore\IEnvironment::ALPHA];
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsProduction () {
        /** @var $this \MvcCore\Environment */
        if ($this->name === NULL) $this->GetName();
        return $this->values[\MvcCore\IEnvironment::PRODUCTION];
    }

    /**
     * @inheritDocs
     * @return bool
     */
    public function IsDetected () {
        /** @var $this \MvcCore\Environment */
        return $this->name !== NULL;
    }

    /**
     * @inheritDocs
     * @param string $name
     * @return string
     */
    public function SetName ($name = \MvcCore\IEnvironment::PRODUCTION) {
        /** @var $this \MvcCore\Environment */
        $this->name = $name;
        foreach (static::GetAllNames() as $envName)
            $this->values[$envName] = FALSE;
        $this->values[$this->name] = TRUE;
        return $name;
    }

    /**
     * @inheritDocs
     * @return string
     */
    public function GetName () {
        /** @var $this \MvcCore\Environment */
        if ($this->name === NULL) {
            if (static::$detectionBySystemConfig) {
                $app = self::$app ?: (self::$app = \MvcCore\Application::GetInstance());
                $configClass = $app->GetConfigClass();
                $sysConfig = $configClass::GetSystem(TRUE);
                if ($sysConfig) {
                    $envDetectionData = & $configClass::GetEnvironmentDetectionData($sysConfig);
                    $this->name = static::DetectBySystemConfig((array) $envDetectionData);
                    // Set up system config current environment data collection for first time:
                    $configClass::SetUpEnvironmentData($sysConfig, $this->name);
                }
                // if not recognized by system config, recognize only
                // by simplest way - by server and client IP:
                if ($this->name === NULL)
                    $this->name = static::DetectByIps();
            } else {
                $this->name = static::DetectByIps();
            }
            foreach (static::GetAllNames() as $envName)
                $this->values[$envName] = FALSE;
            $this->values[$this->name] = TRUE;
        }
        return $this->name;
    }
}