| 1: | <?php |
| 2: | /* |
| 3: | * SimpleID |
| 4: | * |
| 5: | * Copyright (C) Kelvin Mo 2014-2026 |
| 6: | * |
| 7: | * This program is free software; you can redistribute it and/or |
| 8: | * modify it under the terms of the GNU General Public |
| 9: | * License as published by the Free Software Foundation; either |
| 10: | * version 2 of the License, or (at your option) any later version. |
| 11: | * |
| 12: | * This program is distributed in the hope that it will be useful, |
| 13: | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14: | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15: | * General Public License for more details. |
| 16: | * |
| 17: | * You should have received a copy of the GNU General Public |
| 18: | * License along with this program; if not, write to the Free |
| 19: | * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 20: | * |
| 21: | */ |
| 22: | |
| 23: | namespace SimpleID\Auth; |
| 24: | |
| 25: | use SimpleID\Module; |
| 26: | use SimpleID\ModuleManager; |
| 27: | |
| 28: | /** |
| 29: | * An abstract authentication scheme module. |
| 30: | * |
| 31: | * This module contains convenience variables, `$auth` |
| 32: | * and `$mgr`, pointing to instances of |
| 33: | * `AuthManager` and `ModuleManager` |
| 34: | * respectively |
| 35: | */ |
| 36: | abstract class AuthSchemeModule extends Module { |
| 37: | |
| 38: | /** @var AuthManager */ |
| 39: | protected $auth; |
| 40: | |
| 41: | /** @var ModuleManager */ |
| 42: | protected $mgr; |
| 43: | |
| 44: | public function __construct() { |
| 45: | parent::__construct(); |
| 46: | $this->auth = AuthManager::instance(); |
| 47: | $this->mgr = ModuleManager::instance(); |
| 48: | } |
| 49: | |
| 50: | /** |
| 51: | * Returns whether the specified block ID is the active form. |
| 52: | * |
| 53: | * An authentication module may use this function to determine whether |
| 54: | * the form should be validated and processed by this module. |
| 55: | * |
| 56: | * @param string $block_id the block ID |
| 57: | * @return bool |
| 58: | */ |
| 59: | protected function isBlockActive(string $block_id): bool { |
| 60: | return (!$this->f3->exists('POST.op') && ($this->f3->get('POST.active_block') == $block_id)); |
| 61: | } |
| 62: | } |
| 63: | ?> |