services/VersionService.php

   1 <?php
   2 /**
   3  * VersionService
   4  *
   5  * @package   OpenEMR
   6  * @link      http://www.open-emr.org
   7  * @author    Matthew Vita <matthewvita48@gmail.com>
   8  * @copyright Copyright (c) 2017 Matthew Vita <matthewvita48@gmail.com>
   9  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  10  */
  11
  12
  13 namespace OpenEMR\Services;
  14
  15 use OpenEMR\Common\Database\Connector;
  16 use OpenEMR\Common\Logging\Logger;
  17 use OpenEMR\Entities\Version;
  18
  19 class VersionService
  20 {
  21     /**
  22      * Logger used primarily for logging events that are of interest to
  23      * developers.
  24      */
  25     private $logger;
  26
  27     /**
  28      * The version repository to be used for db CRUD operations.
  29      */
  30     private $repository;
  31
  32     /**
  33      * Default constructor.
  34      */
  35     public function __construct()
  36     {
  37         $this->logger = new Logger("\OpenEMR\Services\VersionService");
  38         $database = Connector::Instance();
  39         $entityManager = $database->entityManager;
  40         $this->repository = $entityManager->getRepository('\OpenEMR\Entities\Version');
  41     }
  42
  43     /**
  44      * Before potentially making any updates to the system, we need to ensure
  45      * the version table exists.
  46      *
  47      * @return bool
  48      */
  49     public function doesTableExist()
  50     {
  51         return $this->repository->doesTableExist();
  52     }
  53
  54     /**
  55      * @return the sole version entry in the database.
  56      */
  57     public function fetch()
  58     {
  59         $version = $this->repository->findFirst();
  60
  61         if (empty($version)) {
  62             $this->logger->error("No version found");
  63             return null;
  64         }
  65
  66         return $version;
  67     }
  68
  69     /**
  70      * Updates the sole version entry in the database. If the release contains
  71      * a patch file, also updates the real patch indicator.
  72      *
  73      * @param $version the new version entry.
  74      * @return true/false for if the update went through.
  75      */
  76     public function update(Version $version)
  77     {
  78         $this->logger->debug("Updating version entry");
  79         if (!$this->canRealPatchBeApplied($version)) {
  80             $version->setRealPatch(0);
  81         }
  82
  83         return $this->repository->update($version);
  84     }
  85
  86     /**
  87      * @return bool if the release contains a patch file or not.
  88      */
  89     public function canRealPatchBeApplied(Version $version)
  90     {
  91         $this->logger->debug("Determining if a real patch can be applied");
  92         //Collected below function call to a variable, since unable to directly include
  93         // function calls within empty() in php versions < 5.5 .
  94         $version_getrealpatch = $version->getRealPatch();
  95         return !empty($version_getrealpatch) && ($version->getRealPatch() != "") && ($version->getRealPatch() > 0);
  96     }
  97 }