Subversion Repositories oidplus

Rev

Rev 1086 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 1086 Rev 1116
1 
<?php
 1 
<?php
2 
 
 2 
 
3 
/*
 3 
/*
4 
 * OIDplus 2.0
 4 
 * OIDplus 2.0
5 
 * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
 5 
 * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
6 
 *
 6 
 *
7 
 * Licensed under the Apache License, Version 2.0 (the "License");
 7 
 * Licensed under the Apache License, Version 2.0 (the "License");
8 
 * you may not use this file except in compliance with 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
 9 
 * You may obtain a copy of the License at
10 
 *
 10 
 *
11 
 *     http://www.apache.org/licenses/LICENSE-2.0
 11 
 *     http://www.apache.org/licenses/LICENSE-2.0
12 
 *
 12 
 *
13 
 * Unless required by applicable law or agreed to in writing, software
 13 
 * Unless required by applicable law or agreed to in writing, software
14 
 * distributed under the License is distributed on an "AS IS" BASIS,
 14 
 * distributed under the License is distributed on an "AS IS" BASIS,
15 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 
 * See the License for the specific language governing permissions and
 16 
 * See the License for the specific language governing permissions and
17 
 * limitations under the License.
 17 
 * limitations under the License.
18 
 */
 18 
 */
19 
 
 19 
 
20 
namespace ViaThinkSoft\OIDplus;
 20 
namespace ViaThinkSoft\OIDplus;
21 
 
 21 
 
22 
// phpcs:disable PSR1.Files.SideEffects
 22 
// phpcs:disable PSR1.Files.SideEffects
23 
\defined('INSIDE_OIDPLUS') or die;
 23 
\defined('INSIDE_OIDPLUS') or die;
24 
// phpcs:enable PSR1.Files.SideEffects
 24 
// phpcs:enable PSR1.Files.SideEffects
25 
 
 25 
 
26 
abstract class OIDplusCaptchaPlugin extends OIDplusPlugin {
 26 
abstract class OIDplusCaptchaPlugin extends OIDplusPlugin {
27 
 
 27 
 
- 
 
 28 
        /**
- 
 
 29 
         * @return string
- 
 
 30 
         */
28 
        public abstract static function id(): string; // this is the name that is set to the configuration value OIDplus::baseConfig()->getValue('CAPTCHA_PLUGIN') to identify the CAPTCHA plugin
 31 
        public abstract static function id(): string; // this is the name that is set to the configuration value OIDplus::baseConfig()->getValue('CAPTCHA_PLUGIN') to identify the CAPTCHA plugin
29 
 
 32 
 
- 
 
 33 
        /**
- 
 
 34 
         * @return bool
- 
 
 35 
         */
30 
        public abstract function isVisible(): bool;
 36 
        public abstract function isVisible(): bool;
31 
 
 37 
 
- 
 
 38 
        /**
- 
 
 39 
         * @param string|null $header_text
- 
 
 40 
         * @param string|null $footer_text
- 
 
 41 
         * @return string
- 
 
 42 
         */
32 
        public abstract function captchaGenerate($header_text=null, $footer_text=null);
 43 
        public abstract function captchaGenerate(string $header_text=null, string $footer_text=null): string;
33 
 
 44 
 
- 
 
 45 
        /**
- 
 
 46 
         * @param string[] $params
- 
 
 47 
         * @param string|null $fieldname
- 
 
 48 
         * @return void
- 
 
 49 
         */
34 
        public abstract function captchaVerify($params, $fieldname=null);
 50 
        public abstract function captchaVerify(array $params, string $fieldname=null);
35 
 
 51 
 
- 
 
 52 
        /**
- 
 
 53 
         * @return string
- 
 
 54 
         */
36 
        public abstract static function setupHTML(): string;
 55 
        public abstract static function setupHTML(): string;
37 
 
 56 
 
38 
}
 57 
}
39 
 
 58