.. _variables-uncommonenvvar:

.. _environment-variables:

Environment Variables
+++++++++++++++++++++

  Environment variables are used to interact with the hosting system. 

They often provides configuration parameter that are set by the host of the application to be used. 
That way, information is not hardcoded in the application, and may be changed at production.

.. code-block:: php
   
   <?php
   
   //ENVIRONMENT set the production context
   if (getenv('ENVIRONMENT') === 'Production') {
       $sshKey = getenv('HOST_KEY');
   } elseif (getenv('ENVIRONMENT') === 'Developper') {
       $sshKey = 'NO KEY';
   } else {
       header('No website here.');
       die();
   }
   
   ?>

See also `$_ENV <https://www.php.net/reserved.variables.environment.php>`_.

Connex PHP features
-------------------

  + `environment-variable <https://php-dictionary.readthedocs.io/en/latest/dictionary/environment-variable.ini.html>`_


Specs
_____

+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Short name   | Variables/UncommonEnvVar                                                                                                                                                                |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Rulesets     | :ref:`All <ruleset-All>`, :ref:`Appinfo <ruleset-Appinfo>`, :ref:`CE <ruleset-CE>`, :ref:`Changed Behavior <ruleset-Changed-Behavior>`                                                  |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Exakat since | 1.0.5                                                                                                                                                                                   |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| PHP Version  | All                                                                                                                                                                                     |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Severity     |                                                                                                                                                                                         |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Time To Fix  |                                                                                                                                                                                         |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Precision    | Medium                                                                                                                                                                                  |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Available in | `Entreprise Edition <https://www.exakat.io/entreprise-edition>`_, `Community Edition <https://www.exakat.io/community-edition>`_, `Exakat Cloud <https://www.exakat.io/exakat-cloud/>`_ |
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+