3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
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
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
24 use Friendica\Core\L10n;
27 * This mock module enable class encapsulation of legacy global function modules.
28 * After having provided the module file name, all the methods will behave like a normal Module class.
30 * @author Hypolite Petovan <mrpetovan@gmail.com>
32 class LegacyModule extends BaseModule
35 * The module name, which is the name of the file (without the .php suffix)
36 * It's used to check for existence of the module functions.
40 private $moduleName = '';
42 public function __construct(L10n $l10n, string $file_path = '', array $parameters = [])
44 parent::__construct($l10n, $parameters);
46 $this->setModuleFile($file_path);
48 $this->runModuleFunction('init');
52 * The only method that needs to be called, with the module/addon file name.
54 * @param string $file_path
57 private function setModuleFile($file_path)
59 if (!is_readable($file_path)) {
60 throw new \Exception(DI::l10n()->t('Legacy module file not found: %s', $file_path));
63 $this->moduleName = basename($file_path, '.php');
65 require_once $file_path;
68 public function content(): string
70 return $this->runModuleFunction('content');
73 public function post()
75 $this->runModuleFunction('post');
79 * Runs the module function designated by the provided suffix if it exists, the BaseModule method otherwise
81 * @param string $function_suffix
85 private function runModuleFunction(string $function_suffix)
87 $function_name = $this->moduleName . '_' . $function_suffix;
89 if (\function_exists($function_name)) {
91 return $function_name($a);