interface/eRxGlobals.php

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