class.ilGSProviderStorage.php

Go to the documentation of this file.

<?php

class ilGSProviderStorage extends CachedActiveRecord
{

    public function getCache() : ilGlobalCache
    {
        return ilGlobalCache::getInstance(ilGlobalCache::COMP_GLOBAL_SCREEN);
    }


    public static function registerIdentifications(string $class_name, string $purpose)
    {
        if (!class_exists($class_name)) {
            throw new LogicException("Cannot store unknown provider {$class_name}");
        }

        $gsp = ilGSProviderStorage::find($class_name);
        if ($gsp === null) {
            $gsp = new ilGSProviderStorage();
            $gsp->setProviderClass($class_name);
            $gsp->create();
        }
        $gsp->setProviderClass($class_name);
        $gsp->setPurpose($purpose);
        $gsp->setDynamic(in_array(DynamicProvider::class, class_implements($class_name)));
        $gsp->update();

        $instance = $gsp->getInstance();

        foreach ($instance->getAllIdentifications() as $identification) {
            ilGSIdentificationStorage::registerIdentification($identification, $instance);
        }
    }


    protected $provider_class;
    protected $purpose = '';
    protected $dynamic = false;
    protected $instance;
    protected $connector_container_name = "il_gs_providers";


    final public function getConnectorContainerName()
    {
        return $this->connector_container_name;
    }


    public function getProviderClass() : string
    {
        return $this->provider_class;
    }


    public function setProviderClass(string $provider_class) : ilGSProviderStorage
    {
        $this->provider_class = $provider_class;

        return $this;
    }


    public function getPurpose() : string
    {
        return $this->purpose;
    }


    public function setPurpose(string $purpose) : ilGSProviderStorage
    {
        $this->purpose = $purpose;

        return $this;
    }


    public function isDynamic() : bool
    {
        return $this->dynamic;
    }


    public function setDynamic(bool $dynamic) : ilGSProviderStorage
    {
        $this->dynamic = $dynamic;

        return $this;
    }


    public function getInstance() : ILIAS\GlobalScreen\Provider\Provider
    {
        global $DIC;
        if (!$this->instance instanceof ILIAS\GlobalScreen\Provider\Provider) {
            $class_name = $this->provider_class;
            $this->instance = new $class_name($DIC);
        }

        return $this->instance;
    }
}