Subversion Repositories oidplus

Rev

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

  1. <?php
  2.  
  3. /*
  4.  * OIDplus 2.0
  5.  * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
  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.  
  20. namespace ViaThinkSoft\OIDplus;
  21.  
  22. // phpcs:disable PSR1.Files.SideEffects
  23. \defined('INSIDE_OIDPLUS') or die;
  24. // phpcs:enable PSR1.Files.SideEffects
  25.  
  26. abstract class OIDplusCaptchaPlugin extends OIDplusPlugin {
  27.  
  28.         /**
  29.          * @return string
  30.          */
  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
  32.  
  33.         /**
  34.          * @return bool
  35.          */
  36.         public abstract function isVisible(): bool;
  37.  
  38.         /**
  39.          * @return bool
  40.          * @throws OIDplusException
  41.          */
  42.         public final function isActive(): bool {
  43.                 return OIDplus::getActiveCaptchaPluginId() == $this->id();
  44.         }
  45.  
  46.         /**
  47.          * @param string|null $header_text
  48.          * @param string|null $footer_text
  49.          * @return string
  50.          */
  51.         public abstract function captchaGenerate(string $header_text=null, string $footer_text=null): string;
  52.  
  53.         /**
  54.          * @param string[] $params
  55.          * @param string|null $fieldname
  56.          * @return void
  57.          */
  58.         public abstract function captchaVerify(array $params, string $fieldname=null);
  59.  
  60.         /**
  61.          * @return string
  62.          */
  63.         public abstract static function setupHTML(): string;
  64.  
  65. }
  66.