class.ilPluginSlotInfo.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

class ilPluginSlotInfo
{
    protected ilComponentInfo $component;
    protected string $id;
    protected string $name;
    protected array $plugins;

    public function __construct(
        ilComponentInfo $component,
        string $id,
        string $name,
        array &$plugins
    ) {
        $this->component = $component;
        $this->id = $id;
        $this->name = $name;
        $this->plugins = &$plugins;
    }

    public function getComponent(): ilComponentInfo
    {
        return $this->component;
    }

    public function getId(): string
    {
        return $this->id;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getQualifiedName(): string
    {
        return $this->component->getQualifiedName() . "/" . $this->getName();
    }

    public function getPath(): string
    {
        return ilComponentRepository::PLUGIN_BASE_PATH . "/" . $this->getQualifiedName();
    }

    public function getPlugins(): Iterator
    {
        foreach ($this->plugins as $id => $plugin) {
            yield $id => $plugin;
        }
    }

    public function hasPluginId(string $id): bool
    {
        return isset($this->plugins[$id]);
    }

    public function getPluginById(string $id): \ilPluginInfo
    {
        if (!$this->hasPluginId($id)) {
            throw new \InvalidArgumentException(
                "No plugin $id in slot {$this->getQualifiedName()}."
            );
        }
        return $this->plugins[$id];
    }

    public function hasPluginName(string $name): bool
    {
        foreach ($this->getPlugins() as $plugin) {
            if ($plugin->getName() === $name) {
                return true;
            }
        }
        return false;
    }

    public function getPluginByName(string $name): \ilPluginInfo
    {
        foreach ($this->getPlugins() as $plugin) {
            if ($plugin->getName() === $name) {
                return $plugin;
            }
        }
        throw new \InvalidArgumentException(
            "No plugin with name $name in slot {$this->getQualifiedName()}."
        );
    }

    public function getActivePlugins(): Iterator
    {
        foreach ($this->getPlugins() as $id => $plugin) {
            if ($plugin->isActive()) {
                yield $id => $plugin;
            }
        }
    }

    public function hasActivePlugins(): bool
    {
        foreach ($this->getActivePlugins() as $_) {
            return true;
        }
        return false;
    }
}