aboutsummaryrefslogtreecommitdiff
path: root/classes/Calculatable.php
diff options
context:
space:
mode:
Diffstat (limited to 'classes/Calculatable.php')
-rw-r--r--classes/Calculatable.php58
1 files changed, 58 insertions, 0 deletions
diff --git a/classes/Calculatable.php b/classes/Calculatable.php
new file mode 100644
index 0000000..d98f969
--- /dev/null
+++ b/classes/Calculatable.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * Provides the calculatable trait, to be used by something of which
+ * subtotal, VAT and total can be calculated.
+ *
+ * @author Camil Staps
+ *
+ * BusinessAdmin: administrative software for small companies
+ * Copyright (C) 2015 Camil Staps (ViviSoft)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * The calculatable trait, to be used by something of which subtotal, VAT and
+ * total can be calculated
+ */
+trait Calculatable {
+ abstract public function calculateSubtotal();
+ abstract public function calculateVAT();
+
+ public function calculateTotal() {
+ return $this->calculateSubtotal() + $this->calculateVAT();
+ }
+
+ public function calculate($what = self::TOTAL, $round = 2, $format = true) {
+ $return = 0;
+ switch ($what) {
+ case self::SUBTOTAL:
+ $return = $this->calculateSubtotal();
+ break;
+ case self::VAT:
+ $return = $this->calculateVAT();
+ break;
+ case self::TOTAL:
+ $return = $this->calculateTotal();
+ break;
+ default:
+ return false;
+ }
+ if ($format) {
+ return number_format($return, $round);
+ } else {
+ return $return;
+ }
+ }
+}