entities/ProductRegistration.php

   1 <?php
   2 /**
   3  * Product Registration entity.
   4  *
   5  * Copyright (C) 2017 Sherwin Gaddis <sherwingaddis@gmail.com>
   6  *
   7  * LICENSE: This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://opensource.org/licenses/gpl-license.php>;.
  17  *
  18  * @package OpenEMR
  19  * @author  Sherwin Gaddis <sherwingaddis@gmail.com>
  20  * @link    http://www.open-emr.org
  21  */
  22
  23 namespace OpenEMR\Entities;
  24
  25 use Doctrine\ORM\Mapping\Entity;
  26 use Doctrine\ORM\Mapping\Table;
  27 use Doctrine\ORM\Mapping\Column;
  28 use Doctrine\ORM\Mapping\Id;
  29
  30 /**
  31  * @Table(name="product_registration")
  32  * @Entity(repositoryClass="OpenEMR\Repositories\ProductRegistrationRepository")
  33  */
  34 class ProductRegistration
  35 {
  36     /**
  37      * Default constructor.
  38      */
  39     public function __construct()
  40     {
  41     }
  42
  43     /**
  44      * @Id
  45      * @Column(name="registration_id"), type="char", length=36 nullable=false, options={"default" : 0})
  46      */
  47     private $registrationId;
  48
  49     /**
  50      * @Column(name="email"), type="varchar", length=255 nullable=false, options={"default" : 0})
  51      */
  52     private $email;
  53
  54     /**
  55      * @Column(name="opt_out"), type="tinyint", length=1 nullable=false, options={"default" : 0})
  56      */
  57     private $optOut;
  58
  59     /**
  60      * Status that can be set/get as a human-readable string for the client. Not stored in the database.
  61      */
  62     private $statusAsString;
  63
  64     /**
  65      * Getter for registration id.
  66      *
  67      * return registration id
  68      */
  69     public function getRegistrationId()
  70     {
  71         return $this->registrationId;
  72     }
  73
  74     /**
  75      * Setter for registration id.
  76      *
  77      * @param registration id
  78      */
  79     public function setRegistrationId($value)
  80     {
  81         $this->registrationId = $value;
  82     }
  83
  84     /**
  85      * Getter for email.
  86      *
  87      * return email string
  88      */
  89     public function getEmail()
  90     {
  91         return $this->email;
  92     }
  93
  94     /**
  95      * Setter for email.
  96      *
  97      * @param email string
  98      */
  99     public function setEmail($value)
 100     {
 101         $this->email = $value;
 102     }
 103
 104     /**
 105      * Getter for opt out.
 106      *
 107      * return opt out string
 108      */
 109     public function getOptOut()
 110     {
 111         return $this->optOut;
 112     }
 113
 114     /**
 115      * Setter for opt out.
 116      *
 117      * @param opt out number
 118      */
 119     public function setOptOut($value)
 120     {
 121         $this->optOut = $value;
 122     }
 123
 124     /**
 125      * Setter for status that can be set/get as a human-readable string for the client.
 126      * Not stored in the database.
 127      *
 128      * return human-readable status.
 129      */
 130     public function getStatusAsString()
 131     {
 132         return $this->statusAsString;
 133     }
 134
 135     /**
 136      * Getter for status that can be set/get as a human-readable string for the client.
 137      * Not stored in the database.
 138      *
 139      * @param human-readable status.
 140      */
 141     public function setStatusAsString($value)
 142     {
 143         $this->statusAsString = $value;
 144     }
 145
 146     /**
 147      * ToString of the entire object.
 148      *
 149      * @return object as string
 150      */
 151     public function __toString()
 152     {
 153         return "registrationId: '" . $this->getRegistrationId() . "' " .
 154                "email: '" . $this->getEmail() . "' " .
 155                "statusAsString: '" . $this->getStatusAsString() . "' " .
 156                "optOut" . $this->getOptOut() . "' " ;
 157     }
 158
 159     /**
 160      * ToSerializedObject of the entire object.
 161      *
 162      * @return object as serialized object.
 163      */
 164     public function toSerializedObject()
 165     {
 166         return get_object_vars($this);
 167     }
 168 }