Subversion Repositories oidplus

Rev

Rev 1116 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 daniel-mar 1
<?php
2
 
3
/*
4
 * OIDplus 2.0
1086 daniel-mar 5
 * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
2 daniel-mar 6
 *
7
 * Licensed under the Apache License, Version 2.0 (the "License");
8
 * you may not use this file except in compliance with the License.
9
 * You may obtain a copy of the License at
10
 *
11
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 *
13
 * Unless required by applicable law or agreed to in writing, software
14
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 * See the License for the specific language governing permissions and
17
 * limitations under the License.
18
 */
19
 
1050 daniel-mar 20
namespace ViaThinkSoft\OIDplus;
511 daniel-mar 21
 
1086 daniel-mar 22
// phpcs:disable PSR1.Files.SideEffects
23
\defined('INSIDE_OIDPLUS') or die;
24
// phpcs:enable PSR1.Files.SideEffects
25
 
246 daniel-mar 26
abstract class OIDplusDatabasePlugin extends OIDplusPlugin {
150 daniel-mar 27
 
1116 daniel-mar 28
        /**
29
         * @return string
30
         */
275 daniel-mar 31
        public abstract static function id(): string; // this is the name that is set to the configuration value OIDplus::baseConfig()->getValue('DATABASE_PLUGIN') to identify the database plugin
261 daniel-mar 32
 
1116 daniel-mar 33
        /**
1211 daniel-mar 34
         * @return bool
35
         * @throws OIDplusException
36
         */
37
        public final function isActive(): bool {
38
                return (strtolower($this->id()) == strtolower(OIDplus::baseConfig()->getValue('DATABASE_PLUGIN','')));
39
        }
40
 
41
        /**
1116 daniel-mar 42
         * @return OIDplusDatabaseConnection
43
         */
305 daniel-mar 44
        public abstract static function newConnection(): OIDplusDatabaseConnection;
274 daniel-mar 45
 
1116 daniel-mar 46
        /**
47
         * @return string
48
         */
305 daniel-mar 49
        public abstract static function setupHTML(): string;
50
 
2 daniel-mar 51
}