Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * Interface for exposing the database transaction functionality.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2024.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Database
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development:plugins:database_gateways Wiki
28 */
29
30namespace VuFind\Db\Service\Feature;
31
32/**
33 * Interface for exposing the database transaction functionality.
34 *
35 * @category VuFind
36 * @package  Database
37 * @author   Demian Katz <demian.katz@villanova.edu>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org/wiki/development:plugins:database_gateways Wiki
40 */
41interface TransactionInterface
42{
43    /**
44     * Begin a database transaction.
45     *
46     * @return void
47     * @throws Exception
48     */
49    public function beginTransaction(): void;
50
51    /**
52     * Commit a database transaction.
53     *
54     * @return void
55     * @throws Exception
56     */
57    public function commitTransaction(): void;
58
59    /**
60     * Roll back a database transaction.
61     *
62     * @return void
63     * @throws Exception
64     */
65    public function rollBackTransaction(): void;
66}