class.ilComponent.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
require_once('class.ilCachedComponentData.php');

define("IL_COMP_MODULE", "Modules");
define("IL_COMP_SERVICE", "Services");
define("IL_COMP_PLUGIN", "Plugins");
define("IL_COMP_SLOTS", "Slots");

abstract class ilComponent
{
    abstract public function getVersion();
    
    abstract public function isCore();

    abstract public function getComponentType() : string;
    
    abstract public function getName();


    protected $global_cache;

    public function __construct()
    {
        $this->global_cache = ilCachedComponentData::getInstance();

        $this->setId($this->global_cache->lookCompId($this->getComponentType(), $this->getName()));
        $this->setPluginSlots(ilComponent::lookupPluginSlots(
            $this->getComponentType(),
            $this->getName()
        ));
    }
    
    final public function setId($a_id)
    {
        $this->id = $a_id;
    }

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

    final public function setPluginSlots($a_pluginslots)
    {
        $this->pluginslots = $a_pluginslots;
    }

    final public function getPluginSlots()
    {
        return $this->pluginslots;
    }

    final public static function getComponentObject($a_ctype, $a_cname)
    {
        global $DIC;
        $ilDB = $DIC->database();

        $set = $ilDB->queryF(
            "SELECT * FROM il_component WHERE type = %s " .
            " AND name = %s",
            array("text", "text"),
            array($a_ctype, $a_cname)
        );
        if (!$ilDB->fetchAssoc($set)) {
            return null;
        }
        
        switch ($a_ctype) {
            case IL_COMP_MODULE:
                if (is_file("./Modules/" . $a_cname . "/classes/class.il" . $a_cname . "Module.php")) {
                    include_once("./Modules/" . $a_cname . "/classes/class.il" . $a_cname . "Module.php");
                    $class = "il" . $a_cname . "Module";
                    $comp = new $class();
                    return $comp;
                }
                break;
                
            case IL_COMP_SERVICE:
                if (is_file("./Services/" . $a_cname . "/classes/class.il" . $a_cname . "Service.php")) {
                    include_once("./Services/" . $a_cname . "/classes/class.il" . $a_cname . "Service.php");
                    $class = "il" . $a_cname . "Service";
                    $comp = new $class();
                    return $comp;
                }
                break;
        }
        
        return null;
    }

    public function setSubDirectory($a_subdirectory)
    {
        $this->subdirectory = $a_subdirectory;
    }

    public function getSubDirectory()
    {
        return $this->subdirectory;
    }
    
    public static function lookupPluginSlots($a_type, $a_name)
    {
        $cached_component = ilCachedComponentData::getInstance();
        $recs = $cached_component->lookupPluginSlotByComponent($a_type . "/" . $a_name);

        $ps = array();
        foreach ($recs as $rec) {
            $rec["dir"] = "Customizing/global/plugins/" . $a_type . "/" . $a_name . "/" . $rec["name"];
            $rec["dir_pres"] = "Customizing/global/plugins/<br />" . $a_type . "/" . $a_name . "/" . $rec["name"];
            $rec["lang_prefix"] = ilComponent::lookupId($a_type, $a_name) . "_" . $rec["id"] . "_";
            $ps[$rec["id"]] = $rec;
        }
        return $ps;
    }
    
    public function getPluginSlotName($a_id)
    {
        $slots = $this->getPluginSlots();
        
        return $slots[$a_id]["name"];
    }

    public function getPluginSlotDirectory($a_id)
    {
        $slots = $this->getPluginSlots();
        
        return "Customizing/global/plugins/" . $this->getComponentType() . "/" .
            $this->getName() . "/" . $slots[$a_id]["name"];
    }
    
    public function getPluginSlotLanguagePrefix($a_id)
    {
        $slots = $this->getPluginSlots();
        return $this->getId() . "_" . $slots[$a_id]["id"] . "_";
    }
    
    public static function lookupId($a_type, $a_name)
    {
        $global_cache = ilCachedComponentData::getInstance();

        return $global_cache->lookCompId($a_type, $a_name);
    }
    
    public static function getComponentInfo($a_type, $a_name)
    {
        $global_cache = ilCachedComponentData::getInstance();

        return $global_cache->lookupCompInfo($a_type, $a_name);
    }
    
    final public static function checkVersionNumber($a_ver)
    {
        $parts = explode(".", $a_ver);

        if (count($parts) < 2 || count($parts) > 3) {
            return "Version number does not conform to format a.b or a.b.c";
        }
        
        if (!is_numeric($parts[0]) || !is_numeric($parts[1])) {
            return "Not all version number parts a.b or a.b.c are numeric.";
        }

        if (isset($parts[2]) && !is_numeric($parts[2])) {
            return "Not all version number parts a.b.c are numeric.";    
        }

        return $parts;
    }

    final public static function isVersionGreaterString($a_ver1, $a_ver2)
    {
        $a_arr1 = ilComponent::checkVersionNumber($a_ver1);
        $a_arr2 = ilComponent::checkVersionNumber($a_ver2);

        if (is_array($a_arr1) && is_array($a_arr2)) {
            return ilComponent::isVersionGreater($a_ver1, $a_ver2);
        } else {
            return false;
        }
    }

    final public static function isVersionGreater(string $version1, string $version2) : bool
    {
        return version_compare($version1, $version2, '>');
    }
    
    public static function lookupComponentName($a_component_id)
    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $query = 'SELECT name from il_component ' .
                'WHERE id = ' . $ilDB->quote($a_component_id, 'text');
        
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->name;
        }
    }

    public static function getAll()
    {
        global $DIC;
        $ilDB = $DIC->database();

        $set = $ilDB->query("SELECT * FROM il_component");
        $comps = [];
        while ($rec = $ilDB->fetchAssoc($set)) {
            $comps[$rec["id"]] = $rec;
        }
        return $comps;
    }
}