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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
<?php
/**
* Provides the model class, an abstract interface to a database table
*
* @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/>.
*/
/**
* Thrown in Model when a table row could not be found
*/
class ModelNotFoundException extends Exception {
}
/**
* Thrown in Model when a column cannot be edited
*/
class ModelIllegalAccessException extends Exception {
}
/**
* Thrown in Model when a call to __set() fails
*/
class ModelSetFailedException {
}
/**
* An abstract interface to a database table
*/
abstract class Model {
/**
* @var string $table The database table
* @var string[] $protected_columns Columns that cannot be edited
* @var string[] $fillable_columns Columns that can be edited
* @var string $primary_key The table's primary key
*/
public
$table = '',
$protected_columns = ['id'],
$fillable_columns = [],
$primary_key = 'id';
/**
* @var PDO $pdo A PDO instance for database communication
* @var mixed[] $data The column values
*/
protected $pdo, $data;
/**
* Create a new instance
*
* @param PDO $pdo The PDO class, to access the database
* @param int $id The id of the row to fetch
*
* @throws PDOException If something went wrong with the database
* @throws ModelNotFoundException If the id could not be found
*/
public function __construct($pdo, $id) {
$this->pdo = $pdo;
$stmt = $this->pdo->prepare("SELECT * FROM `".$this->table()."` WHERE `{$this->primary_key}`=?");
$stmt->execute([$id]);
if ($stmt->rowCount() == 0) {
throw new ModelNotFoundException("The {$this->table} with id '$id' could not be found.");
}
$this->data = $stmt->fetch(PDO::FETCH_ASSOC);
}
/**
* Set a column value
*
* @param string $key The column
* @param mixed $value The value
*
* @throws PDOException Database error
*/
public function __set($key, $value) {
if (!in_array($key, $this->fillable_columns)) {
throw new ModelIllegalAccessException("Column $key cannot be edited.");
}
if ($this->data[$key] == $value) {
return;
}
$stmt = $this->pdo->prepare("UPDATE `".$this->table()."` SET `$key`=? WHERE `{$this->primary_key}`=?");
$stmt->execute([
$this->mutator($key, $value),
$this->data[$this->primary_key]
]);
if ($stmt->rowCount() != 1) {
throw new ModelEditFailedException();
}
$this->data[$key] = $value;
}
/**
* Get a column value
*
* @param string $key The column
*
* @return mixed The value
*/
public function __get($key) {
return $this->accessor($key, $this->data[$key]);
}
/**
* Post-__get() hook to modify the value
*
* @param string $key The column
* @param string $value The value
*
* @return string The modified value (default: $value)
*/
protected function accessor($key, $value) {
return $value;
}
/**
* Pre-__set() hook to modify a value
*
* @param string $key The column
* @param mixed $value The value
*
* @return string The modified value (default: $value casted to string)
*/
protected function mutator($key, $value) {
return (string) $value;
}
/**
* Delete the row
*
* @throws PDOException Database error
*
* @return bool True iff the row was really deleted
*/
public function delete() {
$stmt = $this->pdo->prepare("DELETE FROM `{$this->table()}` WHERE `{$this->primary_key}`=?");
$stmt->execute([$this->data[$this->primary_key]]);
return $stmt->rowCount() != 0;
}
/**
* The actual table, after adding prefixes and the like
*
* @return string The database table
*/
private function table() {
return Constants::db_prefix . $this->table;
}
}
|
