Use extension names instead of IDs when erroring on enable/disable re…

…qs (#2563)
flarum · Jan 29, 2021 · 843daf6 · 843daf6
1 parent 930fcf9
commit 843daf6
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 32 deletions.
diff --git a/src/Extension/Exception/DependentExtensionsException.php b/src/Extension/Exception/DependentExtensionsException.php
@@ -11,6 +11,7 @@
 
 use Exception;
 use Flarum\Extension\Extension;
+use Flarum\Extension\ExtensionManager;
 
 /**
  * This exception is thrown when someone attempts to disable an extension
@@ -30,18 +31,6 @@ public function __construct(Extension $extension, array $dependent_extensions)
         $this->extension = $extension;
         $this->dependent_extensions = $dependent_extensions;
 
-        parent::__construct($extension->getId().' could not be disabled, because it is a dependency of: '.implode(', ', $this->getDependentExtensionIds()));
-    }
-
-    /**
-     * Get array of IDs for extensions that depend on this extension.
-     *
-     * @return array
-     */
-    public function getDependentExtensionIds()
-    {
-        return array_map(function (Extension $extension) {
-            return $extension->getId();
-        }, $this->dependent_extensions);
+        parent::__construct($extension->getTitle().' could not be disabled, because it is a dependency of: '.implode(', ', ExtensionManager::pluckTitles($dependent_extensions)));
     }
 }
diff --git a/src/Extension/Exception/DependentExtensionsExceptionHandler.php b/src/Extension/Exception/DependentExtensionsExceptionHandler.php
@@ -9,6 +9,7 @@
 
 namespace Flarum\Extension\Exception;
 
+use Flarum\Extension\ExtensionManager;
 use Flarum\Foundation\ErrorHandling\HandledError;
 
 class DependentExtensionsExceptionHandler
@@ -26,8 +27,8 @@ protected function errorDetails(DependentExtensionsException $e): array
     {
         return [
             [
-                'extension' => $e->extension->getId(),
-                'extensions' => $e->getDependentExtensionIds(),
+                'extension' => $e->extension->getTitle(),
+                'extensions' => ExtensionManager::pluckTitles($e->dependent_extensions),
             ]
         ];
     }

diff --git a/src/Extension/Exception/MissingDependenciesException.php b/src/Extension/Exception/MissingDependenciesException.php
@@ -11,6 +11,7 @@
 
 use Exception;
 use Flarum\Extension\Extension;
+use Flarum\Extension\ExtensionManager;
 
 /**
  * This exception is thrown when someone attempts to enable an extension
@@ -30,18 +31,6 @@ public function __construct(Extension $extension, array $missing_dependencies =
         $this->extension = $extension;
         $this->missing_dependencies = $missing_dependencies;
 
-        parent::__construct($extension->getId().' could not be enabled, because it depends on: '.implode(', ', $this->getMissingDependencyIds()));
-    }
-
-    /**
-     * Get array of IDs for missing (disabled) extensions that this extension depends on.
-     *
-     * @return array
-     */
-    public function getMissingDependencyIds()
-    {
-        return array_map(function (Extension $extension) {
-            return $extension->getId();
-        }, $this->missing_dependencies);
+        parent::__construct($extension->getTitle().' could not be enabled, because it depends on: '.implode(', ', ExtensionManager::pluckTitles($missing_dependencies)));
     }
 }
diff --git a/src/Extension/Exception/MissingDependenciesExceptionHandler.php b/src/Extension/Exception/MissingDependenciesExceptionHandler.php
@@ -9,6 +9,7 @@
 
 namespace Flarum\Extension\Exception;
 
+use Flarum\Extension\ExtensionManager;
 use Flarum\Foundation\ErrorHandling\HandledError;
 
 class MissingDependenciesExceptionHandler
@@ -26,8 +27,8 @@ protected function errorDetails(MissingDependenciesException $e): array
     {
         return [
             [
-                'extension' => $e->extension->getId(),
-                'extensions' => $e->getMissingDependencyIds(),
+                'extension' => $e->extension->getTitle(),
+                'extensions' => ExtensionManager::pluckTitles($e->missing_dependencies),
             ]
         ];
     }

diff --git a/src/Extension/Extension.php b/src/Extension/Extension.php
@@ -278,6 +278,14 @@ public function getId()
         return $this->id;
     }
 
+    /**
+     * @return string
+     */
+    public function getTitle()
+    {
+        return $this->composerJsonAttribute('extra.flarum-extension.title');
+    }
+
     /**
      * @return string
      */

diff --git a/src/Extension/ExtensionManager.php b/src/Extension/ExtensionManager.php
@@ -114,7 +114,7 @@ public function getExtensions()
             }
 
             $this->extensions = $extensions->sortBy(function ($extension, $name) {
-                return $extension->composerJsonAttribute('extra.flarum-extension.title');
+                return $extension->getTitle();
             });
         }
 
@@ -369,4 +369,17 @@ public function isEnabled($extension)
 
         return isset($enabled[$extension]);
     }
+
+    /**
+     * Returns the titles of the extensions passed.
+     *
+     * @param array $exts
+     * @return string[]
+     */
+    public static function pluckTitles(array $exts)
+    {
+        return array_map(function (Extension $extension) {
+            return $extension->getTitle();
+        }, $exts);
+    }
 }
diff --git a/src/Install/Steps/EnableBundledExtensions.php b/src/Install/Steps/EnableBundledExtensions.php
@@ -111,7 +111,7 @@ private function loadExtensions()
             })->filter(function (Extension $extension) {
                 return in_array($extension->getId(), self::EXTENSION_WHITELIST);
             })->sortBy(function (Extension $extension) {
-                return $extension->composerJsonAttribute('extra.flarum-extension.title');
+                return $extension->getTitle();
             })->mapWithKeys(function (Extension $extension) {
                 return [$extension->getId() => $extension];
             });