src/Entity/Embeddable/BillingItemPrice.php line 13

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity\Embeddable;
  5. use Doctrine\ORM\Mapping as ORM;
  6. use MedBrief\MSR\Entity\BillingItem;
  8. /**
  9. * BillingItemPrice
  10. *
  11. * @ORM\Embeddable
  12. */
  13. class BillingItemPrice
  14. {
  15. // Unit options
  16. public const UNIT_MINUTES = 1;
  17. public const UNIT_MATTER = 2;
  18. public const UNIT_PAGE = 3;
  19. public const UNIT_DISC = 4;
  20. public const UNIT_CENTRE = 5;
  21. public const UNIT_METRE = 6;
  22. public const UNIT_FILM = 7;
  23. public const UNIT_DISBURSEMENT = 8;
  24. public const UNIT_XRAY = 9;
  25. public const UNIT_UNIT = 10;
  26. public const UNIT_HOUR = 11;
  27. public const UNIT_BATCH = 12;
  28. public const UNIT_CLIENT = 13;
  29. public const UNIT_INVOICE = 14;
  30. public const UNIT_CHRONOLOGY = 15;
  31. public const UNIT_ITEM = 16;
  33. /**
  34. * @var string
  35. *
  36. * @ORM\Column(name="amount", type="decimal", precision=7, scale=2)
  37. */
  38. protected $amount;
  40. /**
  41. * @var string
  42. *
  43. * @ORM\Column(name="unit", type="string")
  44. */
  45. protected $unit;
  47. /**
  48. * @var string
  49. *
  50. * @ORM\Column(name="unitDescription", type="string")
  51. */
  52. protected $unitDescription;
  54. /**
  55. * @var int
  56. *
  57. * @ORM\Column(name="unitQuantity", type="integer")
  58. */
  59. protected $unitQuantity;
  61. /**
  62. * @var bool
  63. *
  64. * @ORM\Column(name="vatInclusive", type="boolean", options={"default"=false})
  65. */
  66. protected $vatInclusive;
  68. /**
  69. * Option to hide this billing item from invoices.
  70. *
  71. * @var bool
  72. *
  73. * @ORM\Column(name="hideFromInvoice", type="boolean")
  74. */
  75. protected $hideFromInvoice;
  77. /**
  78. * Constructor
  79. */
  80. public function __construct()
  81. {
  82. // Assign default values to booleans
  83. $this->vatInclusive = false;
  84. $this->hideFromInvoice = false;
  85. }
  87. /**
  88. * __toString
  89. *
  90. * @return string
  91. */
  92. public function __toString()
  93. {
  94. return (string) '£' . $this->amount . ' per ' . $this->getUnitDescription();
  95. }
  97. /**
  98. * Set amount
  99. *
  100. * @param string $amount
  101. *
  102. * @return self
  103. */
  104. public function setAmount($amount)
  105. {
  106. $this->amount = $amount;
  108. return $this;
  109. }
  111. /**
  112. * Get amount
  113. *
  114. * @return string
  115. */
  116. public function getAmount()
  117. {
  118. return $this->amount;
  119. }
  121. /**
  122. * Set unit
  123. *
  124. * @param string $unit
  125. *
  126. * @return self
  127. */
  128. public function setUnit($unit)
  129. {
  130. $this->unit = $unit;
  132. return $this;
  133. }
  135. /**
  136. * Get unit
  137. *
  138. * @return string
  139. */
  140. public function getUnit()
  141. {
  142. return $this->unit;
  143. }
  145. /**
  146. * Get unit options
  147. *
  148. * @return string
  149. */
  150. public static function getUnitOptions()
  151. {
  152. return [
  153. self::UNIT_MINUTES => 'Minutes',
  154. self::UNIT_MATTER => 'Matter',
  155. self::UNIT_PAGE => 'Page',
  156. self::UNIT_DISC => 'Disc',
  157. self::UNIT_CENTRE => 'Centre',
  158. self::UNIT_METRE => 'Metre',
  159. self::UNIT_FILM => 'Film',
  160. self::UNIT_DISBURSEMENT => 'Disbursement',
  161. self::UNIT_XRAY => 'Xray',
  162. self::UNIT_UNIT => 'Unit',
  163. self::UNIT_HOUR => 'Hour',
  164. self::UNIT_BATCH => 'Batch',
  165. self::UNIT_CLIENT => 'Client',
  166. self::UNIT_INVOICE => 'Invoice',
  167. self::UNIT_CHRONOLOGY => 'Chronology',
  168. self::UNIT_ITEM => 'Item',
  169. ];
  170. }
  172. /**
  173. * Get unit label
  174. *
  175. * @return string
  176. */
  177. public function getUnitLabel()
  178. {
  179. $options = self::getUnitOptions();
  180. return $options[$this->getUnit()] ?? '';
  181. }
  183. /**
  184. * Set unitDescription
  185. *
  186. * @param string $unitDescription
  187. *
  188. * @return self
  189. */
  190. public function setUnitDescription($unitDescription)
  191. {
  192. $this->unitDescription = $unitDescription;
  194. return $this;
  195. }
  197. /**
  198. * Get unitDescription
  199. *
  200. * @return string
  201. */
  202. public function getUnitDescription()
  203. {
  204. return $this->unitDescription;
  205. }
  207. /**
  208. * Set unitQuantity
  209. *
  210. * @param int $unitQuantity
  211. *
  212. * @return self
  213. */
  214. public function setUnitQuantity($unitQuantity)
  215. {
  216. $this->unitQuantity = $unitQuantity;
  218. return $this;
  219. }
  221. /**
  222. * Get unitQuantity
  223. *
  224. * @return int
  225. */
  226. public function getUnitQuantity()
  227. {
  228. return $this->unitQuantity;
  229. }
  231. /**
  232. * Set vatInclusive
  233. *
  234. * @param bool $vatInclusive
  235. *
  236. * @return BillingItemPrice
  237. */
  238. public function setVatInclusive($vatInclusive)
  239. {
  240. $this->vatInclusive = $vatInclusive;
  242. return $this;
  243. }
  245. /**
  246. * Get vatInclusive
  247. *
  248. * @return bool
  249. */
  250. public function getVatInclusive()
  251. {
  252. return $this->vatInclusive;
  253. }
  255. /**
  256. * Get vatInclusiveLabel
  257. *
  258. * @return bool
  259. */
  260. public function getVatInclusiveLabel()
  261. {
  262. return $this->vatInclusive ? 'Yes' : 'No';
  263. }
  265. /**
  266. * Set hideFromInvoice
  267. *
  268. * @param bool $hideFromInvoice
  269. *
  270. * @return BillingItem
  271. */
  272. public function setHideFromInvoice($hideFromInvoice)
  273. {
  274. $this->hideFromInvoice = $hideFromInvoice;
  276. return $this;
  277. }
  279. /**
  280. * Get hideFromInvoice
  281. *
  282. * @return bool
  283. */
  284. public function getHideFromInvoice()
  285. {
  286. return $this->hideFromInvoice;
  287. }
  289. /**
  290. * Returns the label for the hideFromInvoice field.
  291. *
  292. * @return string
  293. */
  294. public function getHideFromInvoiceLabel()
  295. {
  296. return $this->getHideFromInvoice() ? 'Yes' : 'No';
  297. }
  298. }