refactor: Move to using ServicesTrait and add getter methods for services

Author: Andrew Welch

src/Transcoder.php

@@ -26,10 +26,8 @@
 use craft\utilities\ClearCaches;
 use craft\web\twig\variables\CraftVariable;
 use craft\web\UrlManager;
-use nystudio107\pluginvite\services\VitePluginService;
-use nystudio107\transcoder\assetbundles\transcoder\TranscoderAsset;
 use nystudio107\transcoder\models\Settings;
-use nystudio107\transcoder\services\Transcode;
+use nystudio107\transcoder\services\ServicesTrait;
 use nystudio107\transcoder\variables\TranscoderVariable;
 use yii\base\ErrorException;
 use yii\base\Event;
@@ -40,14 +38,14 @@
  * @author    nystudio107
  * @package   Transcode
  * @since     1.0.0
- *
- * @property Transcode $transcode
- * @property Settings $settings
- * @property VitePluginService $vite
- * @method   Settings   getSettings()
  */
 class Transcoder extends Plugin
 {
+    // Traits
+    // =========================================================================
+
+    use ServicesTrait;
+
     // Static Properties
     // =========================================================================
 
@@ -61,32 +59,6 @@ class Transcoder extends Plugin
      */
     public static $settings;
 
-    // Static Methods
-    // =========================================================================
-
-    /**
-     * @inheritdoc
-     */
-    public function __construct($id, $parent = null, array $config = [])
-    {
-        $config['components'] = [
-            'transcode' => Transcode::class,
-            // Register the vite service
-            'vite' => [
-                'class' => VitePluginService::class,
-                'assetClass' => TranscoderAsset::class,
-                'useDevServer' => true,
-                'devServerPublic' => 'http://localhost:3001',
-                'serverPublic' => 'http://localhost:8000',
-                'errorEntry' => 'src/js/app.ts',
-                'devServerInternal' => 'http://craft-transcoder-buildchain:3001',
-                'checkDevServer' => true,
-            ],
-        ];
-
-        parent::__construct($id, $parent, $config);
-    }
-
     // Public Properties
     // =========================================================================
 

src/services/ServicesTrait.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * Transcoder plugin for Craft CMS
+ *
+ * Transcode videos to various formats, and provide thumbnails of the video
+ *
+ * @link      https://nystudio107.com
+ * @copyright Copyright (c) 2022 nystudio107
+ */
+
+namespace nystudio107\transcoder\services;
+
+use craft\helpers\ArrayHelper;
+use nystudio107\pluginvite\services\VitePluginService;
+use nystudio107\transcoder\assetbundles\transcoder\TranscoderAsset;
+use yii\base\InvalidConfigException;
+
+/**
+ * @author    nystudio107
+ * @package   Transcode
+ * @since     1.2.23
+ *
+ * @property Transcode $transcode
+ * @property VitePluginService $vite
+ */
+trait ServicesTrait
+{
+    // Public Methods
+    // =========================================================================
+
+    /**
+     * @inheritdoc
+     */
+    public function __construct($id, $parent = null, array $config = [])
+    {
+        // Merge in the passed config, so it our config can be overridden by Plugins::pluginConfigs['vite']
+        // ref: https://github.com/craftcms/cms/issues/1989
+        $config = ArrayHelper::merge([
+            'components' => [
+                'transcode' => Transcode::class,
+                // Register the vite service
+                'vite' => [
+                    'class' => VitePluginService::class,
+                    'assetClass' => TranscoderAsset::class,
+                    'useDevServer' => true,
+                    'devServerPublic' => 'http://localhost:3001',
+                    'serverPublic' => 'http://localhost:8000',
+                    'errorEntry' => 'src/js/app.ts',
+                    'devServerInternal' => 'http://craft-transcoder-buildchain:3001',
+                    'checkDevServer' => true,
+                ],
+            ]
+        ], $config);
+
+        parent::__construct($id, $parent, $config);
+    }
+
+    /**
+     * Returns the transcode service
+     *
+     * @return Transcode The transcode service
+     * @throws InvalidConfigException
+     */
+    public function getTranscode(): Transcode
+    {
+        return $this->get('transcode');
+    }
+
+    /**
+     * Returns the vite service
+     *
+     * @return VitePluginService The vite service
+     * @throws InvalidConfigException
+     */
+    public function getVite(): VitePluginService
+    {
+        return $this->get('vite');
+    }
+}