src/Validators/ProcessingResult.php

   1 <?php
   2
   3 namespace OpenEMR\Validators;
   4
   5 /**
   6  * OpenEMR Service Processing Result
   7  *
   8  * Data contained within a processing result includes:
   9  * - isValid: indicates if the data provided to the service was valid
  10  * - validatiomMessages: validation errors, if any, which occurred during processing
  11  * - internalErrors: system related errors, if any, which occured during processing
  12  * - data: the return value of the operation/process (array)
  13  *
  14  * @package   OpenEMR
  15  * @link      http://www.open-emr.org
  16  * @author    Dixon Whitmire <dixonwh@gmail.com>
  17  * @copyright Copyright (c) 2020 Dixon Whitmire <dixonwh@gmail.com>
  18  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  19  */
  20
  21 class ProcessingResult
  22 {
  23     private $validationMessages;
  24     private $internalErrors;
  25     private $data;
  26
  27     /**
  28      * Initializes internal data structures to an internal array.
  29      */
  30     public function __construct()
  31     {
  32         $this->validationMessages = [];
  33         $this->internalErrors = [];
  34         $this->data = [];
  35     }
  36
  37     /**
  38      * @return true if the instance does not contain validation messages/errors
  39      */
  40     public function isValid()
  41     {
  42         return count($this->validationMessages) == 0;
  43     }
  44
  45     public function getValidationMessages()
  46     {
  47         return $this->validationMessages;
  48     }
  49
  50     public function setValidationMessages($validationMessages)
  51     {
  52         $this->validationMessages = $validationMessages;
  53     }
  54
  55     public function getInternalErrors()
  56     {
  57         return $this->internalErrors;
  58     }
  59
  60     public function setInternalErrors($internalErrors)
  61     {
  62         $this->internalErrors = $internalErrors;
  63     }
  64
  65     /**
  66      * Appends an internal  error to the current instance.
  67      * @param $internalError - The internal error to append.
  68      */
  69     public function addInternalError($internalError)
  70     {
  71         array_push($this->internalErrors, $internalError);
  72     }
  73
  74     public function getData()
  75     {
  76         return $this->data;
  77     }
  78
  79     public function setData($data)
  80     {
  81         $this->data = $data;
  82     }
  83
  84     /**
  85      * Appends a new data item to the current instance.
  86      * @param $newData The new data item.
  87      */
  88     public function addData($newData)
  89     {
  90         array_push($this->data, $newData);
  91     }
  92
  93     /**
  94      * @return true if the instance has 1 or more internal errors.
  95      */
  96     public function hasInternalErrors()
  97     {
  98         return count($this->internalErrors) > 0;
  99     }
 100
 101     /**
 102      * @return true if the instance contains either validation or internal errors.
 103      */
 104     public function hasErrors()
 105     {
 106         return !$this->isValid() || $this->hasInternalErrors();
 107     }
 108 }