class.ilObjectPlugin.php

Go to the documentation of this file.

<?php

abstract class ilObjectPlugin extends ilObject2
{
    protected ?ilPlugin $plugin = null;
    protected ilComponentFactory $component_factory;

    public function __construct(int $a_ref_id = 0)
    {
        global $DIC;
        $this->component_factory = $DIC["component.factory"];
        $this->initType();
        parent::__construct($a_ref_id, true);
        $this->plugin = $this->getPlugin();
    }


    public static function getPluginObjectByType(string $type): ?ilPlugin
    {
        global $DIC;
        $component_factory = $DIC["component.factory"];
        try {
            return $component_factory->getPlugin($type);
        } catch (InvalidArgumentException $e) {
            ilLoggerFactory::getLogger("obj")->log("There was an error while instantiating repo plugin obj of type: $type. Error: $e");
        }
        return null;
    }

    public static function lookupTxtById(
        string $plugin_id,
        string $lang_var
    ): string {
        $pl = self::getPluginObjectByType($plugin_id);
        return $pl->txt($lang_var);
    }

    protected function getPlugin(): ilPlugin
    {
        if (!$this->plugin) {
            $this->plugin = $this->component_factory->getPlugin($this->getType());
        }
        return $this->plugin;
    }

    final public function txt(string $a_var): string
    {
        return $this->getPlugin()->txt($a_var);
    }

    public function getParentTypes(): array
    {
        return $this->plugin->getParentTypes();
    }

    public static function langExitsById(string $pluginId, string $langVar): bool
    {
        global $DIC;
        $lng = $DIC->language();

        $pl = self::getPluginObjectByType($pluginId);
        $pl->loadLanguageModule();

        return $lng->exists($pl->getPrefix() . "_" . $langVar);
    }

    public function getPrefix(): string
    {
        return $this->getPlugin()->getPrefix();
    }
}