class.ilPluginSlot.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */


include_once("./Services/Component/classes/class.ilPlugin.php");

class ilPluginSlot
{
    protected $prefix = "";

    public function __construct($a_c_type, $a_c_name, $a_slot_id)
    {
        $this->setComponentType($a_c_type);
        $this->setComponentName($a_c_name);
        $this->setSlotId($a_slot_id);
        
        if ($a_slot_id != "") {
            $this->read();
        }
    }
    
    public function read()
    {
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookupPluginSlotById($this->getSlotId());
        $this->setSlotName($rec["name"]);
    }
    
    public function setComponentType($a_componenttype)
    {
        $this->componenttype = $a_componenttype;
    }

    public function getComponentType()
    {
        return $this->componenttype;
    }

    public function setComponentName($a_componentname)
    {
        $this->componentname = $a_componentname;
    }

    public function getComponentName()
    {
        return $this->componentname;
    }

    public function setSlotId($a_slotid)
    {
        $this->slotid = $a_slotid;
    }

    public function getSlotId()
    {
        return $this->slotid;
    }

    public function setSlotName($a_slotname)
    {
        $this->slotname = $a_slotname;
    }

    public function getSlotName()
    {
        return $this->slotname;
    }

    public function getPluginsDirectory()
    {
        return "./Customizing/global/plugins/" . $this->getComponentType() .
            "/" . $this->getComponentName() . "/" . $this->getSlotName();
    }
    
    public static function _getPluginsDirectory($a_ctype, $a_cname, $a_slot_id)
    {
        return "./Customizing/global/plugins/" . $a_ctype .
            "/" . $a_cname . "/" . ilPluginSlot::lookupSlotName($a_ctype, $a_cname, $a_slot_id);
    }
    
    
    public function getPluginPhpFileName($a_plugin_name)
    {
        return $this->getPluginsDirectory() . "/" .
            $a_plugin_name . "/plugin.php";
    }
    
    public function checkPluginPhpFileAvailability($a_plugin_name)
    {
        if (@is_file($this->getPluginPhpFileName($a_plugin_name))) {
            return true;
        }
        
        return false;
    }
    
    public function getPluginClassFileName($a_plugin_name)
    {
        return $this->getPluginsDirectory() . "/" .
            $a_plugin_name . "/classes/class.il" . $a_plugin_name . "Plugin.php";
    }

    public function checkClassFileAvailability($a_plugin_name)
    {
        if (@is_file($this->getPluginClassFileName($a_plugin_name))) {
            return true;
        }
        
        return false;
    }
    
    public function getPrefix()
    {
        if ($this->prefix == "") {
            $this->prefix =
                ilComponent::lookupId(
                    $this->getComponentType(),
                    $this->getComponentName()
                ) . "_" . $this->getSlotId();
        }
            
        return $this->prefix;
    }

    public function getPluginsInformation()
    {
        // read plugins directory
        $pl_dir = $this->getPluginsDirectory();

        if (!@is_dir($pl_dir)) {
            return array();
        }
        
        $dir = opendir($pl_dir);

        $plugins = array();
        while ($file = readdir($dir)) {
            if ($file != "." and
                $file != "..") {
                // directories
                $plugin = $this->readPluginInformation($pl_dir, $file);
                if (!is_null($plugin)) {
                    $plugins[] = $plugin;
                }
            }
        }

        return $plugins;
    }

    public function getPluginInformationFor(string $name) : ?array
    {
        $pl_dir = $this->getPluginsDirectory();

        return $this->readPluginInformation($pl_dir, $name);
    }

    protected function readPluginInformation(string $pl_dir, string $file) : ?array
    {
        global $DIC;
        $ilPluginAdmin = $DIC['ilPluginAdmin'];

        if (@is_dir($pl_dir . "/" . $file) && substr($file, 0, 1) != "." &&
            $this->checkPluginPhpFileAvailability($file)
        ) {
            $plugin = ilPlugin::lookupStoredData(
                $this->getComponentType(),
                $this->getComponentName(),
                $this->getSlotId(),
                $file
            );

            // create record in il_plugin table (if not existing)
            if (count($plugin) == 0) {
                ilPlugin::createPluginRecord(
                    $this->getComponentType(),
                    $this->getComponentName(),
                    $this->getSlotId(),
                    $file
                );

                $plugin = ilPlugin::lookupStoredData(
                    $this->getComponentType(),
                    $this->getComponentName(),
                    $this->getSlotId(),
                    $file
                );
            }

            $pdata = $ilPluginAdmin->getAllData(
                $this->getComponentType(),
                $this->getComponentName(),
                $this->getSlotId(),
                $file
            );

            $plugin = array_merge($plugin, $pdata);

            $plugin["name"] = $file;
            $plugin["plugin_php_file_status"] = $this->checkPluginPhpFileAvailability($file);
            $plugin["class_file_status"] = $this->checkClassFileAvailability($file);
            $plugin["class_file"] = $this->getPluginClassFileName($file);

            return $plugin;
        }
        return null;
    }
    
    public static function lookupSlotId($a_ctype, $a_cname, $a_slot_name)
    {
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookupPluginSlotByName($a_slot_name);

        return $rec['id'];
    }

    public static function lookupSlotName($a_ctype, $a_cname, $a_slot_id)
    {
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookupPluginSlotById($a_slot_id);

        return $rec['name'];
    }

    public function getActivePlugins()
    {
        global $DIC;
        $ilPluginAdmin = $DIC['ilPluginAdmin'];
        
        return $ilPluginAdmin->getActivePluginsForSlot(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId()
        );
    }
    
    
    public static function getAllSlots()
    {
        $cached_component = ilCachedComponentData::getInstance();
        $recs = $cached_component->getIlPluginslotById();

        foreach ($recs as $rec) {
            $pos = strpos($rec["component"], "/");
            $slots[] = array(
                "component_type" => substr($rec["component"], 0, $pos),
                "component_name" => substr($rec["component"], $pos + 1),
                "slot_id" => $rec["id"],
                "slot_name" => $rec["name"]
                );
        }
        
        return $slots;
    }

    public static function getAvailableSlots() : array
    {
        $cached_component = ilCachedComponentData::getInstance();
        $recs = $cached_component->getIlPluginslotById();
        $slots = array();
        foreach ($recs as $rec) {
            if($cached_component->lookupPluginsBySlotId($rec["id"])) {
                $pos = strpos($rec["component"], "/");
                $slots[] = array(
                    "component_type" => substr($rec["component"], 0, $pos),
                    "component_name" => substr($rec["component"], $pos + 1),
                    "slot_id" => $rec["id"],
                    "slot_name" => $rec["name"]
                );
            }
        }
        return $slots;
    }
}