src/LegacyModule.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  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
  15  * GNU Affero General Public License for more details.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica;
  23
  24 /**
  25  * This mock module enable class encapsulation of legacy global function modules.
  26  * After having provided the module file name, all the methods will behave like a normal Module class.
  27  *
  28  * @author Hypolite Petovan <mrpetovan@gmail.com>
  29  */
  30 class LegacyModule extends BaseModule
  31 {
  32         /**
  33          * The module name, which is the name of the file (without the .php suffix)
  34          * It's used to check for existence of the module functions.
  35          *
  36          * @var string
  37          */
  38         private $moduleName = '';
  39
  40         public function __construct(string $file_path = '', array $parameters = [])
  41         {
  42                 parent::__construct($parameters);
  43
  44                 $this->setModuleFile($file_path);
  45         }
  46
  47         /**
  48          * The only method that needs to be called, with the module/addon file name.
  49          *
  50          * @param string $file_path
  51          * @throws \Exception
  52          */
  53         private function setModuleFile($file_path)
  54         {
  55                 if (!is_readable($file_path)) {
  56                         throw new \Exception(DI::l10n()->t('Legacy module file not found: %s', $file_path));
  57                 }
  58
  59                 $this->moduleName = basename($file_path, '.php');
  60
  61                 require_once $file_path;
  62         }
  63
  64         public function init()
  65         {
  66                 $this->runModuleFunction('init');
  67         }
  68
  69         public function content(): string
  70         {
  71                 return $this->runModuleFunction('content');
  72         }
  73
  74         public function post()
  75         {
  76                 $this->runModuleFunction('post');
  77         }
  78
  79         /**
  80          * Runs the module function designated by the provided suffix if it exists, the BaseModule method otherwise
  81          *
  82          * @param string $function_suffix
  83          * @return string
  84          * @throws \Exception
  85          */
  86         private function runModuleFunction(string $function_suffix)
  87         {
  88                 $function_name = $this->moduleName . '_' . $function_suffix;
  89
  90                 if (\function_exists($function_name)) {
  91                         $a = DI::app();
  92                         return $function_name($a);
  93                 } else {
  94                         return parent::{$function_suffix}();
  95                 }
  96         }
  97 }