core controller/model/module structure changes

Author: hinanaya

MODULES_5.5.md

@@ -4,3 +4,6 @@ A refactor in 5.5 changed most of the structure of the core code. In practically
 
 - Module update files no longer extend `OBUpdate`, but instead extend `OpenBroadcaster\Base\Update`.
 - Cron files now extend `OpenBroadcaster\Base\Cron`
+- Module controllers go from `OBFController` -> `OpenBroadcaster\Base\Controller`
+- Module models go from `OBFModel` -> `OpenBroadcaster\Base\Model`
+- Module top level file goes from `OBFModule` -> `OpenBroadcaster\Base\Module`

core/core/obfcontroller.php core/base/Controller.phpcore/core/obfcontroller.php renamed to core/base/Controller.php

@@ -3,14 +3,16 @@
 // Copyright 2012-2024 OpenBroadcaster, Inc.
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
+namespace OpenBroadcaster\Base;
+
 /**
  * Manages controllers. Makes frameworks available, adds associated controller
  * request handlers, and methods get called when calling methods on associated
  * models.
  *
  * @package Class
  */
-class OBFController
+class Controller
 {
     public $load;
     public $db;
@@ -22,17 +24,17 @@ class OBFController
     protected $callback_handler;
 
     /**
-     * Create a new instance of OBFController. Makes various classes of OB available
+     * Create a new instance of Controller. Makes various classes of OB available
      * by default, such as OBFLoad, OBFDB, OBFUser, OBFCallbacks, and OBFHelpers.
      */
     public function __construct()
     {
-        $this->load = OBFLoad::get_instance();
-        $this->db = OBFDB::get_instance();
-        $this->user = OBFUser::get_instance();
-        $this->callback_handler = OBFCallbacks::get_instance();
-        $this->helpers = OBFHelpers::get_instance();
-        $this->models = OBFModels::get_instance();
+        $this->load = \OBFLoad::get_instance();
+        $this->db = \OBFDB::get_instance();
+        $this->user = \OBFUser::get_instance();
+        $this->callback_handler = \OBFCallbacks::get_instance();
+        $this->helpers = \OBFHelpers::get_instance();
+        $this->models = \OBFModels::get_instance();
     }
 
     /**

core/core/obfmodel.php core/base/Model.phpcore/core/obfmodel.php renamed to core/base/Model.php

@@ -3,12 +3,14 @@
 // Copyright 2012-2024 OpenBroadcaster, Inc.
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
+namespace OpenBroadcaster\Base;
+
 /**
  * Model class. Defines basic OB model functionality.
  *
  * @package Class
  */
-class OBFModel
+class Model
 {
     public $load;
     public $db;
@@ -25,12 +27,12 @@ class OBFModel
      */
     public function __construct()
     {
-        $this->load = OBFLoad::get_instance();
-        $this->db = OBFDB::get_instance();
-        $this->user = OBFUser::get_instance();
-        $this->callback_handler = OBFCallbacks::get_instance();
-        $this->helpers = OBFHelpers::get_instance();
-        $this->models = OBFModels::get_instance();
+        $this->load = \OBFLoad::get_instance();
+        $this->db = \OBFDB::get_instance();
+        $this->user = \OBFUser::get_instance();
+        $this->callback_handler = \OBFCallbacks::get_instance();
+        $this->helpers = \OBFHelpers::get_instance();
+        $this->models = \OBFModels::get_instance();
     }
 
     /**

core/core/obfmodule.php core/base/Module.phpcore/core/obfmodule.php renamed to core/base/Module.php

@@ -3,12 +3,14 @@
 // Copyright 2012-2025 OpenBroadcaster, Inc.
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
+namespace OpenBroadcaster\Base;
+
 /**
  * Manages modules.
  *
  * @package Class
  */
-class OBFModule
+class Module
 {
     public $db;
     public $callback_handler;
@@ -19,8 +21,8 @@ class OBFModule
      */
     public function __construct()
     {
-        $this->db = OBFDB::get_instance();
-        $this->callback_handler = OBFCallbacks::get_instance();
+        $this->db = \OBFDB::get_instance();
+        $this->callback_handler = \OBFCallbacks::get_instance();
     }
 
     /**

modules/logger/controllers/logger.php

@@ -3,7 +3,9 @@
 // Copyright 2012-2024 OpenBroadcaster, Inc.
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-class Logger extends OBFController
+use OpenBroadcaster\Base\Controller;
+
+class Logger extends Controller
 {
 
 	public function __construct()

modules/logger/models/logger_model.php

@@ -3,7 +3,9 @@
 // Copyright 2012-2024 OpenBroadcaster, Inc.
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-class LoggerModel extends OBFModel
+use OpenBroadcaster\Base\Model;
+
+class LoggerModel extends Model
 {
 
 	public function log($hook,$position,&$args)

modules/logger/module.php

@@ -3,7 +3,9 @@
 // Copyright 2012-2025 OpenBroadcaster, Inc.
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-class LoggerModule extends OBFModule
+use OpenBroadcaster\Base\Module;
+
+class LoggerModule extends Module
 {
 
     public $name = 'Logger v1.0';

modules/tutorial/module.php

@@ -3,7 +3,9 @@
 // Copyright 2012-2025 OpenBroadcaster, Inc.
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-class TutorialModule extends OBFModule
+use OpenBroadcaster\Base\Module;
+
+class TutorialModule extends Module
 {
 
 	public $name = 'Tutorial v1.0';