interface/eRxGlobals.php

   1 <?php
   2
   3 /**
   4  * interface/eRxGlobals.php Functions for retrieving NewCrop global configurations.
   5  *
   6  * @package   OpenEMR
   7  * @link      http://www.open-emr.org
   8  * @author    Sam Likins <sam.likins@wsi-services.com>
   9  * @copyright Copyright (c) 2015 Sam Likins <sam.likins@wsi-services.com>
  10  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  11  */
  12
  13 use OpenEMR\Common\Crypto\CryptoGen;
  14 use OpenEMR\Services\VersionService;
  15
  16 class eRxGlobals
  17 {
  18     private $configuration;
  19
  20     /**
  21      * Construct eRxGlobals optionally providing an array of configurations to use
  22      * @param array|null &$configuration [optional] Array of configurations to use
  23      */
  24     public function __construct(&$configuration = null)
  25     {
  26         if (is_array($configuration)) {
  27             $this->setGlobals($configuration);
  28         }
  29     }
  30
  31     /**
  32      * Set the configuration array for use in eRxGlobals
  33      * @param array &$configuration Array of configurations to use
  34      */
  35     public function setGlobals(&$configuration)
  36     {
  37         $this->configuration =& $configuration;
  38
  39         return $this;
  40     }
  41
  42     /**
  43      * Return the value stored in configurations specified by the key
  44      * @param  string $key Configuration array key
  45      * @return mixed       Configuration specified by the key
  46      */
  47     public function getGlobalValue($key)
  48     {
  49         if (array_key_exists($key, $this->configuration)) {
  50             return $this->configuration[$key];
  51         }
  52     }
  53
  54     /**
  55      * Return the version of OpenEMR
  56      * @return string OpenEMR version
  57      */
  58     public function getOpenEMRVersion()
  59     {
  60         return (new VersionService())->asString();
  61     }
  62
  63     /**
  64      * Return the OpenEMR site directory
  65      * @return string OpenEMR site directory
  66      */
  67     public function getOpenEMRSiteDirectory()
  68     {
  69         return $this->getGlobalValue('OE_SITE_DIR');
  70     }
  71
  72     /**
  73      * Return enable state for NewCrop eRx service
  74      * @return boolean NewCrop eRx service enabled state
  75      */
  76     public function getEnabled()
  77     {
  78         return $this->getGlobalValue('erx_enable');
  79     }
  80
  81     /**
  82      * Return the NewCrop eRx requests URL
  83      * @return string URL for NewCrop eRx requests
  84      */
  85     public function getPath()
  86     {
  87         return $this->getGlobalValue('erx_newcrop_path');
  88     }
  89
  90     /**
  91      * Return the NewCrop eRx service URLs
  92      * @return array URLs for NewCrop eRx services: index [ 0 = Update, 1 = Patient ]
  93      */
  94     public function getSoapPaths()
  95     {
  96         return explode(';', $this->getGlobalValue('erx_newcrop_path_soap'));
  97     }
  98
  99     /**
 100      * Return the NewCrop eRx allergies time-to-live
 101      * @return integer Time-to-live in seconds for NewCrop eRx allergies
 102      */
 103     public function getTTLSoapAllergies()
 104     {
 105         return $this->getGlobalValue('erx_soap_ttl_allergies');
 106     }
 107
 108     /**
 109      * Return the NewCrop eRx medications time-to-live
 110      * @return integer Time-to-live in seconds for NewCrop eRx medications
 111      */
 112     public function getTTLSoapMedications()
 113     {
 114         return $this->getGlobalValue('erx_soap_ttl_medications');
 115     }
 116
 117     /**
 118      * Return the NewCrop eRx partner name for credentials
 119      * @return string Partner name for credentials
 120      */
 121     public function getPartnerName()
 122     {
 123         return $this->getGlobalValue('erx_account_partner_name');
 124     }
 125
 126     /**
 127      * Return the NewCrop eRx account name for credentials
 128      * @return string Account name for credentials
 129      */
 130     public function getAccountName()
 131     {
 132         return $this->getGlobalValue('erx_account_name');
 133     }
 134
 135     /**
 136      * Return the NewCrop eRx password for credentials
 137      * @return string Password for credentials
 138      */
 139     public function getAccountPassword()
 140     {
 141         $cryptoGen = new CryptoGen();
 142         return $cryptoGen->decryptStandard($this->getGlobalValue('erx_account_password'));
 143     }
 144
 145     /**
 146      * Return the NewCrop eRx account Id for credentials
 147      * @return string Account Id for credentials
 148      */
 149     public function getAccountId()
 150     {
 151         return $this->getGlobalValue('erx_account_id');
 152     }
 153
 154     /**
 155      * Return enable state for NewCrop eRx only upload prescriptions
 156      * @return boolean NewCrop eRx only upload prescriptions enabled state
 157      */
 158     public function getUploadActive()
 159     {
 160         return $this->getGlobalValue('erx_upload_active');
 161     }
 162
 163     /**
 164      * Return enable state for NewCrop eRx import status message
 165      * @return boolean NewCrop eRx import status message enabled state
 166      */
 167     public function getImportStatusMessage()
 168     {
 169         return $this->getGlobalValue('erx_import_status_message');
 170     }
 171
 172     /**
 173      * Return enable state for NewCrop eRx display medications uploaded
 174      * @return boolean NewCrop eRx display medications uploaded enabled state
 175      */
 176     public function getDisplayMedication()
 177     {
 178         return $this->getGlobalValue('erx_medication_display');
 179     }
 180
 181     /**
 182      * Return enable state for NewCrop eRx display allergies uploaded
 183      * @return boolean NewCrop eRx display allergies uploaded enabled state
 184      */
 185     public function getDisplayAllergy()
 186     {
 187         return $this->getGlobalValue('erx_allergy_display');
 188     }
 189
 190     /**
 191      * Return NewCrop eRx default patient country code
 192      * @return string NewCrop eRx default patient country code
 193      */
 194     public function getDefaultPatientCountry()
 195     {
 196         return $this->getGlobalValue('erx_default_patient_country');
 197     }
 198
 199     /**
 200      * Return array containing NewCrop eRx credentials
 201      * @return array NewCrop eRx credentials: index [ 0 = Partner Name, 1 = Account Name, 2 = Password ]
 202      */
 203     public function getCredentials()
 204     {
 205         return array(
 206             $this->getPartnerName(),
 207             $this->getAccountName(),
 208             $this->getAccountPassword(),
 209         );
 210     }
 211
 212     /**
 213      * Return Debug NewCrop eRx settings
 214      * @return integer Debug settings: flags [ 1 = XML, 2 = RESULT ]
 215      */
 216     public function getDebugSetting()
 217     {
 218         return $this->getGlobalValue('erx_debug_setting');
 219     }
 220 }