-
Notifications
You must be signed in to change notification settings - Fork 353
/
Gateway.php
191 lines (175 loc) · 5.2 KB
/
Gateway.php
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<?php
/**
* Generic VuFind table gateway.
*
* PHP version 8
*
* Copyright (C) Villanova University 2010.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2,
* as published by the Free Software Foundation.
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* @category VuFind
* @package Db_Table
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org Main Site
*/
namespace VuFind\Db\Table;
use Exception;
use Laminas\Db\Adapter\Adapter;
use Laminas\Db\TableGateway\AbstractTableGateway;
use Laminas\Db\TableGateway\Feature;
use VuFind\Db\Row\RowGateway;
use function count;
use function is_object;
/**
* Generic VuFind table gateway.
*
* @category VuFind
* @package Db_Table
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org Main Site
*/
class Gateway extends AbstractTableGateway
{
/**
* Table manager
*
* @var PluginManager
*/
protected $tableManager;
/**
* Constructor
*
* @param Adapter $adapter Database adapter
* @param PluginManager $tm Table manager
* @param array $cfg Laminas configuration
* @param RowGateway $rowObj Row prototype object (null for default)
* @param string $table Name of database table to interface with
*/
public function __construct(
Adapter $adapter,
PluginManager $tm,
$cfg,
?RowGateway $rowObj,
$table
) {
$this->adapter = $adapter;
$this->tableManager = $tm;
$this->table = $table;
$this->initializeFeatures($cfg);
$this->initialize();
if (null !== $rowObj) {
$resultSetPrototype = $this->getResultSetPrototype();
$resultSetPrototype->setArrayObjectPrototype($rowObj);
}
}
/**
* Initialize features
*
* @param array $cfg Laminas configuration
*
* @return void
*/
public function initializeFeatures($cfg)
{
// Special case for PostgreSQL sequences:
if ($this->adapter->getDriver()->getDatabasePlatformName() == 'Postgresql') {
$maps = $cfg['vufind']['pgsql_seq_mapping'] ?? null;
if (isset($maps[$this->table])) {
if (!is_object($this->featureSet)) {
$this->featureSet = new Feature\FeatureSet();
}
$this->featureSet->addFeature(
new Feature\SequenceFeature(
$maps[$this->table][0],
$maps[$this->table][1]
)
);
}
}
}
/**
* Create a new row.
*
* @return object
*/
public function createRow()
{
$obj = clone $this->getResultSetPrototype()->getArrayObjectPrototype();
// If this is a PostgreSQL connection, we may need to initialize the ID
// from a sequence:
if (
$this->adapter
&& $this->adapter->getDriver()->getDatabasePlatformName() == 'Postgresql'
&& $obj instanceof \VuFind\Db\Row\RowGateway
) {
// Do we have a sequence feature?
$feature = $this->featureSet->getFeatureByClassName(
'Laminas\Db\TableGateway\Feature\SequenceFeature'
);
if ($feature) {
$key = $obj->getPrimaryKeyColumn();
if (count($key) != 1) {
throw new \Exception('Unexpected number of key columns.');
}
$col = $key[0];
$obj->$col = $feature->nextSequenceId();
}
}
return $obj;
}
/**
* Get access to another table.
*
* @param string $table Table name
*
* @return Gateway
*/
public function getDbTable($table)
{
return $this->tableManager->get($table);
}
/**
* Begin a database transaction.
*
* @return void
* @throws Exception
*/
public function beginTransaction(): void
{
$this->getAdapter()->getDriver()->getConnection()->beginTransaction();
}
/**
* Commit a database transaction.
*
* @return void
* @throws Exception
*/
public function commitTransaction(): void
{
$this->getAdapter()->getDriver()->getConnection()->commit();
}
/**
* Roll back a database transaction.
*
* @return void
* @throws Exception
*/
public function rollBackTransaction(): void
{
$this->getAdapter()->getDriver()->getConnection()->rollback();
}
}