friendica_2021-01/src/LegacyModule.php

96 lines
2.6 KiB
PHP
Raw Normal View History

2018-10-21 04:34:26 +02:00
<?php
2020-02-09 15:45:36 +01:00
/**
* @copyright Copyright (C) 2020, Friendica
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
2018-10-21 04:34:26 +02:00
namespace Friendica;
/**
* This mock module enable class encapsulation of legacy global function modules.
* After having provided the module file name, all the methods will behave like a normal Module class.
*
* @author Hypolite Petovan <mrpetovan@gmail.com>
*/
class LegacyModule extends BaseModule
{
/**
* The module name, which is the name of the file (without the .php suffix)
* It's used to check for existence of the module functions.
*
* @var string
*/
private static $moduleName = '';
/**
* The only method that needs to be called, with the module/addon file name.
*
* @param string $file_path
2019-01-06 22:06:53 +01:00
* @throws \Exception
2018-10-21 04:34:26 +02:00
*/
public static function setModuleFile($file_path)
{
if (!is_readable($file_path)) {
2020-01-18 22:38:31 +01:00
throw new \Exception(DI::l10n()->t('Legacy module file not found: %s', $file_path));
2018-10-21 04:34:26 +02:00
}
self::$moduleName = basename($file_path, '.php');
require_once $file_path;
}
public static function init(array $parameters = [])
2018-10-21 04:34:26 +02:00
{
2019-11-05 21:22:54 +01:00
self::runModuleFunction('init', $parameters);
2018-10-21 04:34:26 +02:00
}
public static function content(array $parameters = [])
2018-10-21 04:34:26 +02:00
{
2019-11-05 21:22:54 +01:00
return self::runModuleFunction('content', $parameters);
2018-10-21 04:34:26 +02:00
}
public static function post(array $parameters = [])
2018-10-21 04:34:26 +02:00
{
2019-11-05 21:22:54 +01:00
self::runModuleFunction('post', $parameters);
2018-10-21 04:34:26 +02:00
}
public static function afterpost(array $parameters = [])
2018-10-21 04:34:26 +02:00
{
2019-11-05 21:22:54 +01:00
self::runModuleFunction('afterpost', $parameters);
2018-10-21 04:34:26 +02:00
}
/**
* Runs the module function designated by the provided suffix if it exists, the BaseModule method otherwise
*
* @param string $function_suffix
* @return string
2019-01-06 22:06:53 +01:00
* @throws \Exception
2018-10-21 04:34:26 +02:00
*/
private static function runModuleFunction($function_suffix, array $parameters = [])
2018-10-21 04:34:26 +02:00
{
$function_name = static::$moduleName . '_' . $function_suffix;
if (\function_exists($function_name)) {
$a = DI::app();
return $function_name($a);
2018-10-21 04:34:26 +02:00
} else {
2019-11-05 21:22:54 +01:00
return parent::{$function_suffix}($parameters);
2018-10-21 04:34:26 +02:00
}
}
}