1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
<?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 interface, to be used by something of which subtotal, VAT
* and total can be calculated
*/
interface Calculatable {
const SUBTOTAL = 1;
const VAT = 2;
const TOTAL = 3;
/**
* Calculate the subtotal
*
* @return float The subtotal
*/
function calculateSubtotal();
/**
* Calculate the VAT
*
* @return float The VAT
*/
function calculateVAT();
/**
* Calculate the total
*
* @return float The total
*/
function calculateTotal();
/**
* Calculate and possibly format
*
* Subtotal: the sum of the prices of the assignments excl. VAT
* VAT: the sum of all the VAT from all the assignments
* Total: the sum of subtotal and total
*
* @param int $what Any of Calculatable::SUBTOTAL, Calculatable::VAT and Calculatable::TOTAL
* @param int $round How many decimals to round the result on
* @param bool $format Whether to format the number nicely (for output) or not (for calculations)
*
* @throws PDOException If something went wrong with the database
*
* @return float|bool The calculated value rounded to $round decimals, or false on incorrect input
*/
function calculate($what = Calculatable::TOTAL, $round = 2, $format = true);
}
/**
* The calculatable trait, to be used by something of which subtotal, VAT and
* total can be calculated
*/
trait StandardCalculatable {
abstract public function calculateSubtotal();
abstract public function calculateVAT();
/**
* Calculate the total
*
* @return float The total
*/
public function calculateTotal() {
return $this->calculateSubtotal() + $this->calculateVAT();
}
/**
* Calculate and possibly format
*
* Subtotal: the sum of the prices of the assignments excl. VAT
* VAT: the sum of all the VAT from all the assignments
* Total: the sum of subtotal and total
*
* @param int $what Any of Calculatable::SUBTOTAL, Calculatable::VAT and Calculatable::TOTAL
* @param int $round How many decimals to round the result on
* @param bool $format Whether to format the number nicely (for output) or not (for calculations)
*
* @throws PDOException If something went wrong with the database
*
* @return float|bool The calculated value rounded to $round decimals, or false on incorrect input
*/
public function calculate($what = Calculatable::TOTAL, $round = 2, $format = true) {
$return = 0;
switch ($what) {
case Calculatable::SUBTOTAL:
$return = $this->calculateSubtotal();
break;
case Calculatable::VAT:
$return = $this->calculateVAT();
break;
case Calculatable::TOTAL:
$return = $this->calculateTotal();
break;
default:
return false;
}
if ($format) {
return number_format($return, $round);
} else {
return $return;
}
}
}
|
