vendor/contao/manager-plugin/src/PluginLoader.php line 37

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * This file is part of Contao.
  7. *
  8. * (c) Leo Feyer
  9. *
  10. * @license LGPL-3.0-or-later
  11. */
  13. namespace Contao\ManagerPlugin;
  15. use Contao\ManagerPlugin\Bundle\BundlePluginInterface;
  16. use Contao\ManagerPlugin\Config\ConfigPluginInterface;
  17. use Contao\ManagerPlugin\Config\ExtensionPluginInterface;
  18. use Contao\ManagerPlugin\Routing\RoutingPluginInterface;
  20. class PluginLoader
  21. {
  22. public const BUNDLE_PLUGINS = BundlePluginInterface::class;
  23. public const CONFIG_PLUGINS = ConfigPluginInterface::class;
  24. public const EXTENSION_PLUGINS = ExtensionPluginInterface::class;
  25. public const ROUTING_PLUGINS = RoutingPluginInterface::class;
  27. /**
  28. * @var array
  29. */
  30. private $plugins = [];
  32. /**
  33. * @var array
  34. */
  35. private $disabled = [];
  37. public function __construct(?string $installedJson = null, ?array $plugins = null)
  38. {
  39. if (null !== $installedJson) {
  40. @trigger_error('Passing the path to the Composer installed.json as first argument is no longer supported in version 2.3.', E_USER_DEPRECATED);
  41. }
  43. if (null !== $plugins) {
  44. $this->plugins = $plugins;
  45. } elseif (is_file(self::getGeneratedPath())) {
  46. $this->plugins = (array) include self::getGeneratedPath();
  47. }
  48. }
  50. public static function getGeneratedPath(): string
  51. {
  52. return __DIR__.'/../.generated/plugins.php';
  53. }
  55. /**
  56. * Returns all active plugin instances.
  57. *
  58. * @return array<string,BundlePluginInterface>
  59. */
  60. public function getInstances(): array
  61. {
  62. return array_diff_key($this->plugins, array_flip($this->disabled));
  63. }
  65. /**
  66. * Returns the active plugin instances of a given type (see class constants).
  67. *
  68. * @return array<string,BundlePluginInterface>
  69. */
  70. public function getInstancesOf(string $type, bool $reverseOrder = false): array
  71. {
  72. $plugins = array_filter(
  73. $this->getInstances(),
  74. static function ($plugin) use ($type) {
  75. return is_a($plugin, $type);
  76. }
  77. );
  79. if ($reverseOrder) {
  80. $plugins = array_reverse($plugins, true);
  81. }
  83. return array_diff_key($plugins, array_flip($this->disabled));
  84. }
  86. /**
  87. * @return array<string>
  88. */
  89. public function getDisabledPackages(): array
  90. {
  91. return $this->disabled;
  92. }
  94. public function setDisabledPackages(array $packages): void
  95. {
  96. $this->disabled = $packages;
  97. }
  98. }