Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
3 / 3
CRAP
100.00% covered (success)
100.00%
1 / 1
DbServiceAwareTrait
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
3 / 3
4
100.00% covered (success)
100.00%
1 / 1
 setDbServiceManager
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getDbServiceManager
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
 getDbService
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * Default implementation of DbServiceAwareInterface.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2023.
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  Db_Service
25 * @author   Sudharma Kellampalli <skellamp@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org Main Site
28 */
29
30namespace VuFind\Db\Service;
31
32/**
33 * Default implementation of DbServiceAwareInterface.
34 *
35 * @category VuFind
36 * @package  Db_Service
37 * @author   Sudharma Kellampalli <skellamp@villanova.edu>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org Main Site
40 */
41trait DbServiceAwareTrait
42{
43    /**
44     * Database service plugin manager
45     *
46     * @var PluginManager
47     */
48    protected $dbServiceManager;
49
50    /**
51     * Set the service plugin manager.
52     *
53     * @param PluginManager $manager Plugin manager
54     *
55     * @return void
56     */
57    public function setDbServiceManager(PluginManager $manager)
58    {
59        $this->dbServiceManager = $manager;
60    }
61
62    /**
63     * Get the service plugin manager. Throw an exception if it is missing.
64     *
65     * @throws \Exception
66     * @return PluginManager
67     */
68    public function getDbServiceManager()
69    {
70        if (null === $this->dbServiceManager) {
71            throw new \Exception('Service manager missing in ' . static::class . '.');
72        }
73        return $this->dbServiceManager;
74    }
75
76    /**
77     * Get a database service object.
78     *
79     * @param class-string<T> $name Name of service to retrieve
80     *
81     * @template T
82     *
83     * @return T
84     */
85    public function getDbService(string $name): DbServiceInterface
86    {
87        return $this->getDbServiceManager()->get($name);
88    }
89}