Feat: Add basic extension loading

Enable loading of phpdoc extensions. Extensions are based on symfony DI extensions. We do check the manifest.xml for compatibility to ensure we have everything needed.
phpDocumentor · Aug 20, 2023 · 691e1c1 · 691e1c1
1 parent 4c2f900
commit 691e1c1
Show file tree

Hide file tree

Showing 15 changed files with 533 additions and 151 deletions.
diff --git a/bin/phpdoc b/bin/phpdoc
@@ -2,6 +2,7 @@
 <?php
 
 use phpDocumentor\AutoloaderLocator;
+use phpDocumentor\Extension\ExtensionHandler;
 use Symfony\Component\Console\Input\ArgvInput;
 
 set_time_limit(0);
@@ -10,7 +11,10 @@ require __DIR__ . '/../src/phpDocumentor/AutoloaderLocator.php';
 $loader = AutoloaderLocator::autoload();
 
 $containerFactory = new \phpDocumentor\Console\ContainerFactory();
-$container = $containerFactory->create(AutoloaderLocator::findVendorPath());
+$container = $containerFactory->create(
+    AutoloaderLocator::findVendorPath(),
+    ExtensionHandler::getInstance(getcwd() . '/.phpdoc/extensions')
+);
 $output = new \Symfony\Component\Console\Output\ConsoleOutput();
 
 $application = $container->get(\phpDocumentor\Console\Application::class);

diff --git a/composer.json b/composer.json
@@ -46,6 +46,8 @@
         "league/uri-interfaces": "^2.0",
         "monolog/monolog": "^2.9",
         "nikic/php-parser": "^4.14",
+        "phar-io/manifest": "^2.0",
+        "phar-io/version": "^3.2",
         "phpdocumentor/flyfinder": "^1.0",
         "phpdocumentor/graphviz": "^2.0",
         "phpdocumentor/guides": "^0.1.0",

diff --git a/composer.lock b/composer.lock
diff --git a/config/services.yaml b/config/services.yaml
@@ -154,6 +154,9 @@ services:
         $files: '@files'
         $descriptors: '@descriptors'
 
+    phpDocumentor\Extension\ExtensionHandler:
+      factory: [ '\phpDocumentor\Extension\ExtensionHandler', 'getInstance' ]
+
     ###################################################################################
     ## Autoloading definitions for external services ##################################
     ###################################################################################

diff --git a/src/phpDocumentor/Application.php b/src/phpDocumentor/Application.php
@@ -13,21 +13,15 @@
 
 namespace phpDocumentor;
 
-use Jean85\PrettyVersions;
-use OutOfBoundsException;
 use RuntimeException;
 use Webmozart\Assert\Assert;
 
 use function date_default_timezone_set;
 use function extension_loaded;
 use function file_exists;
-use function file_get_contents;
 use function getcwd;
 use function ini_get;
 use function ini_set;
-use function ltrim;
-use function sprintf;
-use function trim;
 
 /**
  * Application class for phpDocumentor.
@@ -38,27 +32,6 @@
  */
 final class Application
 {
-    private const VERSION = '@package_version@';
-
-    public static function VERSION(): string
-    {
-        $version = self::VERSION;
-
-        $trickBoxIntoNotReplacingThisScalar = sprintf('%s%s%s', '@', 'package_version', '@');
-        $didBoxReplaceTheVersionPlaceholder = $trickBoxIntoNotReplacingThisScalar !== self::VERSION;
-
-        if ($didBoxReplaceTheVersionPlaceholder === false) {
-            $version = trim(file_get_contents(__DIR__ . '/../../VERSION'));
-            try {
-                $version = PrettyVersions::getRootPackageVersion()->getPrettyVersion();
-                $version = sprintf('%s', ltrim($version, 'v'));
-            } catch (OutOfBoundsException) {
-            }
-        }
-
-        return $version;
-    }
-
     public static function templateDirectory(): string
     {
         $templateDir = __DIR__ . '/../../data/templates';

diff --git a/src/phpDocumentor/AutoloaderLocator.php b/src/phpDocumentor/AutoloaderLocator.php
@@ -26,13 +26,24 @@
 
 final class AutoloaderLocator
 {
+    private static ClassLoader|null $classLoader;
+
+    public static function loader(): ClassLoader
+    {
+        return self::autoload();
+    }
+
     public static function autoload(): ClassLoader
     {
-        if (Phar::running(false)) {
-            return require 'phar://' . Phar::running(false) . '/vendor/autoload.php';
+        if (isset(self::$classLoader) === false) {
+            if (Phar::running(false)) {
+                self::$classLoader = require 'phar://' . Phar::running(false) . '/vendor/autoload.php';
+            } else {
+                self::$classLoader = require self::findVendorPath() . '/autoload.php';
+            }
         }
 
-        return require self::findVendorPath() . '/autoload.php';
+        return self::$classLoader;
     }
 
     /**