ElggPlugin.php

Go to the documentation of this file.

<?php

use Elgg\Database\Delete;
use Elgg\Database\MetadataTable;
use Elgg\Database\Plugins;
use Elgg\Exceptions\DatabaseException;
use Elgg\Exceptions\InvalidArgumentException as ElggInvalidArgumentException;
use Elgg\Exceptions\PluginException;
use Elgg\Includer;
use Elgg\Project\Paths;
use Elgg\Traits\Loggable as ElggLoggable;

class ElggPlugin extends ElggObject {

    const PRIORITY_SETTING_NAME = 'elgg:internal:priority';
    const STATIC_CONFIG_FILENAME = 'elgg-plugin.php';
    const PUBLIC_SERVICES_FILENAME = 'elgg-services.php';
    
    use ElggLoggable;
    
    const ADDITIONAL_TEXT_FILES = [
        'README.txt',
        'CHANGES.txt',
        'INSTALL.txt',
        'COPYRIGHT.txt',
        'LICENSE.txt',
        'README',
        'README.md',
        'README.markdown',
    ];
    
    protected $composer;

    protected $path;

    protected $static_config;
    
    protected $activated;

    protected function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['subtype'] = 'plugin';
    }

    public static function fromId(string $plugin_id, string $path = null): \ElggPlugin {
        if (empty($plugin_id)) {
            throw new ElggInvalidArgumentException('Plugin ID must be set');
        }

        $plugin = elgg_get_plugin_from_id($plugin_id);
        if (!$plugin) {
            $plugin = elgg_call(ELGG_IGNORE_ACCESS, function() use ($plugin_id) {
                $plugin = new ElggPlugin();
                $plugin->title = $plugin_id;
                $plugin->save();
                
                return $plugin;
            });
        }

        if (empty($path)) {
            $path = elgg_get_plugins_path();
        }

        $path = Paths::sanitize($path);
        $plugin->setPath($path . $plugin_id);

        return $plugin;
    }

    public function save(): bool {

        $site = elgg_get_site_entity();

        $this->attributes['owner_guid'] = $site->guid;
        $this->attributes['container_guid'] = $site->guid;
        $this->attributes['access_id'] = ACCESS_PUBLIC;

        $new = !$this->guid;
        $priority = null;
        if ($new) {
            $priority = elgg_extract(self::PRIORITY_SETTING_NAME, $this->temp_metadata, 'new');
        } elseif ($this->getPriority() === null) {
            $priority = 'last';
        }

        if ($priority) {
            $this->setPriority($priority);
        }
        
        return parent::save();
    }

    public function getID(): string {
        return (string) $this->title;
    }

    public function getDisplayName(): string {
        $name = elgg_extract('name', $this->getStaticConfig('plugin', []), '');
        if (!empty($name)) {
            return $name;
        }
        
        return ucwords(str_replace(['-', '_'], ' ', $this->getID()));
    }

    public function setPath(string $path): void {
        $this->path = Paths::sanitize($path, true);
    }

    public function getPath(): string {
        if (isset($this->path)) {
            return $this->path;
        }
        
        $this->setPath(elgg_get_plugins_path() . $this->getID());
        return $this->path;
    }

    protected function getLanguagesPath(): string {
        return $this->getPath() . 'languages/';
    }

    public function getStaticConfig(string $key, $default = null) {
        if ($this->static_config === null) {
            $this->static_config = [];

            try {
                $this->static_config = $this->includeFile(self::STATIC_CONFIG_FILENAME);
            } catch (PluginException $ex) {
                elgg_log($ex, \Psr\Log\LogLevel::ERROR);
            }
        }

        return $this->static_config[$key] ?? $default;
    }

    // Load Priority

    public function getPriority(): ?int {
        $priority = $this->getMetadata(self::PRIORITY_SETTING_NAME);
        if (isset($priority)) {
            return (int) $priority;
        }

        return null;
    }

    public function setPriority($priority): int|false {
        $priority = $this->normalizePriority($priority);

        return _elgg_services()->plugins->setPriority($this, $priority);
    }

    protected function normalizePriority($priority): int {
        // if no priority assume a priority of 1
        $old_priority = $this->getPriority();
        $old_priority = $old_priority ?: 1;
        $max_priority = _elgg_services()->plugins->getMaxPriority() ?: 1;

        // can't use switch here because it's not strict and php evaluates +1 == 1
        if ($priority === '+1') {
            $priority = $old_priority + 1;
        } else if ($priority === '-1') {
            $priority = $old_priority - 1;
        } else if ($priority === 'first') {
            $priority = 1;
        } else if ($priority === 'last') {
            $priority = $max_priority;
        } else if ($priority === 'new') {
            $max_priority++;
            $priority = $max_priority;
        }

        return min($max_priority, max(1, (int) $priority));
    }

    // Plugin settings

    public function getSetting(string $name, $default = null) {
        $values = $this->getAllSettings();
        return elgg_extract($name, $values, $default);
    }

    public function getAllSettings(): array {

        try {
            $defaults = [];
            if ($this->isActive()) {
                // only load settings from static config for active plugins to prevent issues
                // with internal plugin references ie. classes and language keys
                $defaults = $this->getStaticConfig('settings', []);
            }

            $settings = $this->getAllMetadata();
            
            // title and description are not considered settings
            unset($settings['title'], $settings['description']);

            return array_merge($defaults, $settings);
        } catch (DatabaseException $ex) {
            return [];
        }
    }

    public function setSetting(string $name, $value): bool {

        $value = _elgg_services()->events->triggerResults('setting', 'plugin', [
            'plugin_id' => $this->getID(),
            'plugin' => $this,
            'name' => $name,
            'value' => $value,
        ], $value);

        if (is_array($value)) {
            elgg_log('Plugin settings cannot store arrays.', \Psr\Log\LogLevel::ERROR);

            return false;
        }

        return elgg_call(ELGG_DISABLE_SYSTEM_LOG, function() use ($name, $value) {
            return $this->setMetadata($name, $value);
        });
    }

    public function unsetSetting(string $name): bool {
        return elgg_call(ELGG_DISABLE_SYSTEM_LOG, function() use ($name) {
            return (bool) $this->deleteMetadata($name);
        });
    }

    public function unsetAllSettings(): bool {
        $settings = $this->getAllSettings();

        foreach ($settings as $name => $value) {
            if (str_starts_with($name, 'elgg:internal:')) {
                continue;
            }
            
            $this->unsetSetting($name);
        }

        return true;
    }
    
    public function unsetAllEntityAndPluginSettings(): bool {
        // remove all plugin settings
        $result = $this->unsetAllSettings();
        
        // entity plugin settings are stored with the entity
        $delete = Delete::fromTable(MetadataTable::TABLE_NAME);
        $delete->andWhere($delete->compare('name', 'like', "plugin:%_setting:{$this->getID()}:%", ELGG_VALUE_STRING));
        
        try {
            _elgg_services()->db->deleteData($delete);
            _elgg_services()->metadataCache->clear();
            
            $result &= true;
        } catch (DatabaseException $e) {
            elgg_log($e, \Psr\Log\LogLevel::ERROR);
            
            $result &= false;
        }
        
        // trigger an event, so plugin devs can also remove settings
        $params = [
            'entity' => $this,
        ];
        return (bool) _elgg_services()->events->triggerResults('remove:settings', 'plugin', $params, $result);
    }
    
    public function isValid(): bool {
        try {
            $this->assertValid();
            return true;
        } catch (PluginException $e) {
            return false;
        }
    }
    
    public function assertValid(): void {
        if (!$this->getID()) {
            throw PluginException::factory([
                'message' => elgg_echo('ElggPlugin:MissingID', [$this->guid]),
                'plugin' => $this,
            ]);
        }
        
        $this->getComposer()->assertPluginId();
        
        if (file_exists($this->getPath() . 'start.php')) {
            throw PluginException::factory([
                'message' => elgg_echo('ElggPlugin:StartFound', [$this->getID()]),
                'plugin' => $this,
            ]);
        }
    }

    public function isActive(): bool {
        if (isset($this->activated)) {
            return $this->activated;
        }

        $this->activated = elgg_is_active_plugin($this->getID());
        return $this->activated;
    }

    public function canActivate(): bool {
        if ($this->isActive()) {
            return false;
        }
        
        try {
            $this->assertCanActivate();
            return true;
        } catch (PluginException $e) {
            return false;
        }
    }

    public function assertCanActivate(): void {
        $this->assertValid();
        $this->assertDependencies();
    }

    // activating and deactivating

    public function activate(): bool {
        if ($this->isActive()) {
            return false;
        }

        $this->assertCanActivate();

        // Check this before setting status because the file could potentially throw
        $this->assertStaticConfigValid();
        
        if (!$this->setStatus(true)) {
            return false;
        }

        // perform tasks and emit events
        // emit an event. returning false will make this not be activated.
        // we need to do this after it's been fully activated
        // or the deactivate will be confused.
        $params = [
            'plugin_id' => $this->getID(),
            'plugin_entity' => $this,
        ];

        $return = _elgg_services()->events->trigger('activate', 'plugin', $params);

        // if there are any on_enable functions, start the plugin now and run them
        // Note: this will not run re-run the init events!
        if ($return) {
            try {
                elgg_invalidate_caches();

                $this->register();
                
                // directly load languages to have them available during runtime
                $this->loadLanguages();
                
                $this->boot();
                
                $this->getBootstrap()->activate();

                $this->init();
            } catch (PluginException $ex) {
                elgg_log($ex, \Psr\Log\LogLevel::ERROR);

                $return = false;
            }
        }

        if ($return === false) {
            $this->deactivate();
        } else {
            elgg_delete_admin_notice("cannot_start {$this->getID()}");

            elgg_invalidate_caches();
            _elgg_services()->logger->notice("Plugin {$this->getID()} has been activated");
        }

        return $return;
    }
    
    public function getDependencies(): array {
        $plugin_config = $this->getStaticConfig('plugin', []);
        return (array) elgg_extract('dependencies', $plugin_config, []);
    }

    public function canDeactivate(): bool {
        if (!$this->isActive()) {
            return false;
        }

        try {
            $this->assertcanDeactivate();
            return true;
        } catch (PluginException $e) {
            return false;
        }
    }
    
    public function assertCanDeactivate(): void {
        $dependents = [];

        $active_plugins = elgg_get_plugins();

        foreach ($active_plugins as $plugin) {
            $dependencies = $plugin->getDependencies();
            if (!array_key_exists($this->getID(), $dependencies)) {
                continue;
            }
                
            if (elgg_extract('must_be_active', $dependencies[$this->getID()], true)) {
                $dependents[$plugin->getID()] = $plugin;
            }
        }

        if (empty($dependents)) {
            return;
        }

        $list = array_map(function (\ElggPlugin $plugin) {
            $css_id = preg_replace('/[^a-z0-9-]/i', '-', $plugin->getID());

            return elgg_view('output/url', [
                'text' => $plugin->getDisplayName(),
                'href' => "#{$css_id}",
            ]);
        }, $dependents);
        
        $list = implode(', ', $list);
        throw PluginException::factory([
            'message' => elgg_echo('ElggPlugin:Dependencies:ActiveDependent', [$this->getDisplayName(), $list]),
            'plugin' => $this,
        ]);
    }

    public function deactivate(): bool {
        if (!$this->isActive()) {
            return false;
        }

        $this->assertCanDeactivate();

        // emit an event. returning false will cause this to not be deactivated.
        $params = [
            'plugin_id' => $this->getID(),
            'plugin_entity' => $this,
        ];

        $return = _elgg_services()->events->trigger('deactivate', 'plugin', $params);
        if ($return === false) {
            return false;
        }

        $this->getBootstrap()->deactivate();

        $this->deactivateEntities();

        elgg_invalidate_caches();

        _elgg_services()->logger->notice("Plugin {$this->getID()} has been deactivated");

        return $this->setStatus(false);
    }

    public function getBootstrap(): \Elgg\PluginBootstrapInterface {
        $bootstrap = $this->getStaticConfig('bootstrap');
        if ($bootstrap) {
            if (!is_subclass_of($bootstrap, \Elgg\PluginBootstrapInterface::class)) {
                throw PluginException::factory([
                    'message' => elgg_echo('LogicException:InterfaceNotImplemented', [
                        $bootstrap,
                        \Elgg\PluginBootstrapInterface::class
                    ]),
                    'plugin' => $this,
                ]);
            }

            return new $bootstrap($this, elgg());
        }

        return new \Elgg\DefaultPluginBootstrap($this, elgg());
    }

    public function autoload(): void {
        $this->registerClasses();

        $autoload_file = 'vendor/autoload.php';
        if (!$this->canReadFile($autoload_file)) {
            return;
        }
        
        $autoloader = Includer::requireFileOnce("{$this->getPath()}{$autoload_file}");
        
        if (!$autoloader instanceof \Composer\Autoload\ClassLoader) {
            return;
        }
        
        $autoloader->unregister();
        
        // plugins should be appended, composer defaults to prepend
        $autoloader->register(false);
    }

    public function register(): void {
        $this->autoload();

        $this->registerPublicServices();
        $this->activateEntities();
        $this->registerLanguages();
        $this->registerViews();

        $this->getBootstrap()->load();
    }

    public function boot(): void {
        $this->getBootstrap()->boot();
    }

    public function init(): void {
        $this->registerRoutes();
        $this->registerActions();
        $this->registerEntities();
        $this->registerWidgets();
        $this->registerEvents();
        $this->registerViewExtensions();
        $this->registerGroupTools();
        $this->registerViewOptions();
        $this->registerNotifications();

        $this->getBootstrap()->init();
    }

    protected function includeFile(string $filename) {
        $filepath = "{$this->getPath()}{$filename}";

        if (!$this->canReadFile($filename)) {
            $msg = elgg_echo(
                'ElggPlugin:Exception:CannotIncludeFile',
                [$filename, $this->getID(), $this->guid, $this->getPath()]
            );

            throw PluginException::factory([
                'message' => $msg,
                'plugin' => $this,
            ]);
        }

        try {
            $ret = Includer::requireFile($filepath);
        } catch (Exception $e) {
            $msg = elgg_echo(
                'ElggPlugin:Exception:IncludeFileThrew',
                [$filename, $this->getID(), $this->guid, $this->getPath()]
            );

            throw PluginException::factory([
                'message' => $msg,
                'previous' => $e,
                'plugin' => $this,
            ]);
        }

        return $ret;
    }

    protected function canReadFile(string $filename): bool {
        return is_file("{$this->getPath()}{$filename}");
    }

    protected function assertStaticConfigValid(): void {
        if (!$this->canReadFile(self::STATIC_CONFIG_FILENAME)) {
            return;
        }

        ob_start();
        $value = $this->includeFile(self::STATIC_CONFIG_FILENAME);
        if (ob_get_clean() !== '') {
            throw PluginException::factory([
                'message' => elgg_echo('ElggPlugin:activate:ConfigSentOutput'),
                'plugin' => $this,
            ]);
        }

        // make sure can serialize
        $value = @unserialize(serialize($value));
        if (!is_array($value)) {
            throw PluginException::factory([
                'message' => elgg_echo('ElggPlugin:activate:BadConfigFormat'),
                'plugin' => $this,
            ]);
        }
    }

    protected function registerPublicServices(): void {
        $services_path = $this->getPath() . self::PUBLIC_SERVICES_FILENAME;
        if (!is_file($services_path)) {
            return;
        }

        $services = Includer::includeFile($services_path);
        foreach ($services as $name => $definition) {
            elgg()->set($name, $definition);
        }
    }

    protected function registerViews(): void {
        if (_elgg_services()->views->isViewLocationsLoadedFromCache()) {
            return;
        }

        $views = _elgg_services()->views;

        // Declared views first
        $spec = $this->getStaticConfig('views');
        if ($spec) {
            $views->mergeViewsSpec($spec);
        }

        // Allow /views directory files to override
        if (!$views->registerViewsFromPath($this->getPath())) {
            $msg = elgg_echo('ElggPlugin:Exception:CannotRegisterViews', [$this->getID(), $this->guid, $this->getPath()]);

            throw PluginException::factory([
                'message' => $msg,
                'plugin' => $this,
            ]);
        }
    }

    protected function registerEntities(): void {
        $spec = (array) $this->getStaticConfig('entities', []);
        
        foreach ($spec as $entity) {
            if (!isset($entity['type']) || !isset($entity['subtype'])) {
                continue;
            }
            
            $capabilities = elgg_extract('capabilities', $entity, []);
            foreach ($capabilities as $capability => $value) {
                _elgg_services()->entity_capabilities->setCapability($entity['type'], $entity['subtype'], $capability, $value);
            }
        }
    }

    protected function registerActions(): void {
        $actions = _elgg_services()->actions;
        $root_path = $this->getPath();

        $spec = (array) $this->getStaticConfig('actions', []);
        
        foreach ($spec as $action => $action_spec) {
            if (!is_array($action_spec)) {
                continue;
            }

            $access = elgg_extract('access', $action_spec, 'logged_in');
            $handler = elgg_extract('controller', $action_spec);
            if (!$handler) {
                $handler = elgg_extract('filename', $action_spec);
                if (!$handler) {
                    $handler = "{$root_path}actions/{$action}.php";
                }
            }
            
            // unset handled action specs, pass the rest to the action service
            unset($action_spec['access']);
            unset($action_spec['controller']);
            unset($action_spec['filename']);

            $actions->register($action, $handler, $access, $action_spec);
        }
    }

    protected function registerRoutes(): void {
        $routes = _elgg_services()->routes;

        $spec = (array) $this->getStaticConfig('routes', []);
        foreach ($spec as $name => $route_spec) {
            if (!is_array($route_spec)) {
                continue;
            }

            $routes->register($name, $route_spec);
        }
    }

    protected function registerWidgets(): void {
        $widgets = _elgg_services()->widgets;

        $spec = (array) $this->getStaticConfig('widgets', []);
        foreach ($spec as $widget_id => $widget_definition) {
            if (!is_array($widget_definition)) {
                continue;
            }
            
            if (!isset($widget_definition['id'])) {
                $widget_definition['id'] = $widget_id;
            }

            $definition = \Elgg\WidgetDefinition::factory($widget_definition);

            $widgets->registerType($definition);
        }
    }

    public function registerLanguages(): void {
        _elgg_services()->translator->registerLanguagePath($this->getLanguagesPath());
    }

    protected function loadLanguages(): void {
        $languages_path = $this->getLanguagesPath();
        if (!is_dir($languages_path)) {
            return;
        }

        _elgg_services()->translator->registerTranslations($languages_path);
    }

    protected function registerClasses(): void {
        _elgg_services()->autoloadManager->addClasses("{$this->getPath()}classes");
    }

    protected function activateEntities(): void {
        $spec = (array) $this->getStaticConfig('entities', []);
        
        foreach ($spec as $entity) {
            if (isset($entity['type'], $entity['subtype'], $entity['class'])) {
                _elgg_services()->entityTable->setEntityClass($entity['type'], $entity['subtype'], $entity['class']);
            }
        }
    }

    protected function deactivateEntities(): void {
        $spec = (array) $this->getStaticConfig('entities', []);
        
        foreach ($spec as $entity) {
            if (isset($entity['type'], $entity['subtype'], $entity['class'])) {
                _elgg_services()->entityTable->setEntityClass($entity['type'], $entity['subtype']);
            }
        }
    }
    
    protected function registerEvents(): void {
        $events = _elgg_services()->events;

        $spec = (array) $this->getStaticConfig('events', []);

        foreach ($spec as $name => $types) {
            foreach ($types as $type => $callbacks) {
                foreach ($callbacks as $callback => $event_spec) {
                    if (!is_array($event_spec)) {
                        continue;
                    }
                    
                    $unregister = (bool) elgg_extract('unregister', $event_spec, false);

                    if ($unregister) {
                        $events->unregisterHandler($name, $type, $callback);
                    } else {
                        $priority = (int) elgg_extract('priority', $event_spec, 500);
            
                        $events->registerHandler($name, $type, $callback, $priority);
                    }
                }
            }
        }
    }
    
    protected function registerViewExtensions(): void {
        $views = _elgg_services()->views;
        
        $spec = (array) $this->getStaticConfig('view_extensions', []);

        foreach ($spec as $src_view => $extensions) {
            foreach ($extensions as $extention => $extention_spec) {
                if (!is_array($extention_spec)) {
                    continue;
                }
                
                $unextend = (bool) elgg_extract('unextend', $extention_spec, false);

                if ($unextend) {
                    $views->unextendView($src_view, $extention);
                } else {
                    $priority = (int) elgg_extract('priority', $extention_spec, 501);
        
                    $views->extendView($src_view, $extention, $priority);
                }
            }
        }
    }
    
    protected function registerGroupTools(): void {
        $tools = _elgg_services()->group_tools;
        
        $spec = (array) $this->getStaticConfig('group_tools', []);

        foreach ($spec as $tool_name => $tool_options) {
            if (!is_array($tool_options)) {
                continue;
            }
            
            $unregister = (bool) elgg_extract('unregister', $tool_options, false);

            if ($unregister) {
                $tools->unregister($tool_name);
            } else {
                $tools->register($tool_name, $tool_options);
            }
        }
    }
    
    protected function registerViewOptions(): void {
        $spec = (array) $this->getStaticConfig('view_options', []);

        foreach ($spec as $view_name => $options) {
            if (!is_array($options)) {
                continue;
            }
            
            if (isset($options['ajax'])) {
                if ($options['ajax'] === true) {
                    _elgg_services()->ajax->registerView($view_name);
                } else {
                    _elgg_services()->ajax->unregisterView($view_name);
                }
            }
            
            if (isset($options['simplecache']) && $options['simplecache'] === true) {
                _elgg_services()->simpleCache->registerCacheableView($view_name);
            }
        }
    }
    
    protected function registerNotifications(): void {
        $spec = (array) $this->getStaticConfig('notifications', []);

        foreach ($spec as $type => $subtypes) {
            foreach ($subtypes as $subtype => $actions) {
                foreach ($actions as $action => $callback) {
                    if ($callback === false) {
                        _elgg_services()->notifications->unregisterEvent($type, $subtype, [$action]);
                    } elseif ($callback === true) {
                        _elgg_services()->notifications->registerEvent($type, $subtype, [$action]);
                    } else {
                        _elgg_services()->notifications->registerEvent($type, $subtype, [$action], $callback);
                    }
                }
            }
        }
    }

    public function __get($name) {
        // See if its in our base attribute
        if (array_key_exists($name, $this->attributes)) {
            return $this->attributes[$name];
        }

        // object title and description are stored as metadata
        if (in_array($name, ['title', 'description'])) {
            return parent::__get($name);
        }

        $result = $this->getSetting($name);
        if ($result !== null) {
            return $result;
        }

        $defaults = $this->getStaticConfig('settings', []);

        return elgg_extract($name, $defaults, $result);
    }

    public function __set($name, $value) {
        if (array_key_exists($name, $this->attributes)) {
            // Check that we're not trying to change the guid!
            if ((array_key_exists('guid', $this->attributes)) && ($name == 'guid')) {
                return;
            }

            $this->attributes[$name] = $value;

            return;
        }

        // object title and description are stored as metadata
        if (in_array($name, ['title', 'description'])) {
            parent::__set($name, $value);

            return;
        }

        // to make sure we trigger the correct events
        $this->setSetting($name, $value);
    }

    protected function setStatus(bool $active): bool {
        if (!$this->guid) {
            return false;
        }

        $site = elgg_get_site_entity();
        if ($active) {
            $result = $this->addRelationship($site->guid, 'active_plugin');
        } else {
            $result = $this->removeRelationship($site->guid, 'active_plugin');
        }
        
        if ($result) {
            $this->activated = $active;
        }

        $this->invalidateCache();

        return $result;
    }

    public function isCacheable(): bool {
        return true;
    }
    
    public function invalidateCache(): void {
        _elgg_services()->boot->clearCache();
        _elgg_services()->pluginsCache->delete($this->getID());

        parent::invalidateCache();
    }

    protected function getComposer(): \Elgg\Plugin\Composer {
        if (isset($this->composer)) {
            return $this->composer;
        }
        
        $this->composer = new \Elgg\Plugin\Composer($this);
        return $this->composer;
    }
    
    public function meetsDependencies(): bool {
        try {
            $this->assertDependencies();
            
            return true;
        } catch (PluginException $e) {
            return false;
        }
    }
    
    public function assertDependencies(): void {
        $this->getComposer()->assertConflicts();
        $this->getComposer()->assertActivePluginConflicts();
        $this->getComposer()->assertRequiredPhpVersion();
        $this->getComposer()->assertRequiredPhpExtensions();
        $this->assertPluginDependencies();
    }
    
    protected function assertPluginDependencies(): void {
        foreach ($this->getDependencies() as $plugin_id => $plugin_dep) {
            $must_be_active = elgg_extract('must_be_active', $plugin_dep, true);
            $position = elgg_extract('position', $plugin_dep);

            $dependent_plugin = elgg_get_plugin_from_id($plugin_id);
            
            if ($must_be_active && (!$dependent_plugin instanceof \ElggPlugin || !$dependent_plugin->isActive())) {
                throw PluginException::factory([
                    'message' => elgg_echo('PluginException:PluginMustBeActive', [$plugin_id]),
                    'plugin' => $this,
                ]);
            }
            
            if ($dependent_plugin instanceof \ElggPlugin && $position && $dependent_plugin->isActive()) {
                if ($position == 'after' && ($this->getPriority() < $dependent_plugin->getPriority())) {
                    throw PluginException::factory([
                        'message' => elgg_echo('PluginException:PluginMustBeAfter', [$plugin_id]),
                        'plugin' => $this,
                    ]);
                } elseif ($position == 'before' && ($this->getPriority() > $dependent_plugin->getPriority())) {
                    throw PluginException::factory([
                        'message' => elgg_echo('PluginException:PluginMustBeBefore', [$plugin_id]),
                        'plugin' => $this,
                    ]);
                }
            }
        }
    }
    
    public function getVersion(): string {
        // composer version
        $version = $this->getComposer()->getConfiguration()->version();
        if (!elgg_is_empty($version)) {
            return $version;
        }
        
        // elgg-plugin version
        $plugin_config = $this->getStaticConfig('plugin', []);
        $version = elgg_extract('version', $plugin_config);
        if (!elgg_is_empty($version)) {
            return $version;
        }
        
        // bundled plugins use elgg version
        if (in_array($this->getID(), Plugins::BUNDLED_PLUGINS)) {
            return elgg_get_release();
        }
        
        return '0.1';
    }
    
    public function getCategories(): array {
        return $this->getComposer()->getCategories();
    }
    
    public function getLicense(): string {
        return $this->getComposer()->getLicense();
    }
    
    public function getDescription(): string {
        return (string) $this->getComposer()->getConfiguration()->description();
    }
    
    public function getRepositoryURL(): string {
        return (string) $this->getComposer()->getConfiguration()->support()->source();
    }
    
    public function getBugTrackerURL(): string {
        return (string) $this->getComposer()->getConfiguration()->support()->issues();
    }
    
    public function getWebsite(): string {
        return (string) $this->getComposer()->getConfiguration()->homepage();
    }
    
    public function getAuthors(): array {
        return (array) $this->getComposer()->getConfiguration()->authors();
    }
    
    public function getConflicts(): array {
        return $this->getComposer()->getConflicts();
    }
}