interface/eRxGlobals.php

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