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
{
        
        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();
                }
        }
        
        function read()
        {
                $cached_component = ilCachedComponentData::getInstance();

                $rec = $cached_component->lookupPluginSlotById($this->getSlotId());
                //global $ilDB;

                //$q = "SELECT * FROM il_pluginslot WHERE component = ".
                //      $ilDB->quote($this->getComponentType()."/".$this->getComponentName(), "text").
                //      " AND id = ".$ilDB->quote($this->getSlotId(), "text");
                //$set = $ilDB->query($q);
                //$rec = $ilDB->fetchAssoc($set);
                $this->setSlotName($rec["name"]);
        }
        
        function setComponentType($a_componenttype)
        {
                $this->componenttype = $a_componenttype;
        }

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

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

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

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

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

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

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

        function getPluginsDirectory()
        {
                return "./Customizing/global/plugins/".$this->getComponentType().
                        "/".$this->getComponentName()."/".$this->getSlotName();
        }
        
        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);
        }
        
        
        function getPluginPhpFileName($a_plugin_name)
        {
                return $this->getPluginsDirectory()."/".
                        $a_plugin_name."/plugin.php";
        }
        
        function checkPluginPhpFileAvailability($a_plugin_name)
        {
                if (@is_file($this->getPluginPhpFileName($a_plugin_name)))
                {
                        return true;
                }
                
                return false;
        }
        
        function getPluginClassFileName($a_plugin_name)
        {
                return $this->getPluginsDirectory()."/".
                        $a_plugin_name."/classes/class.il".$a_plugin_name."Plugin.php";
        }

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

        function getPluginsInformation()
        {
                global $ilPluginAdmin;
                
                // 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
                                if (@is_dir($pl_dir."/".$file) && substr($file, 0, 1) != "." &&
                                        is_file($pl_dir."/".$file."/plugin.php"))
                                {
                                        
                                        
                                        $plugin = array();
                                        
                                        $plugin = ilPlugin::lookupStoredData($this->getComponentType(),
                                                $this->getComponentName(), $this->getSlotId(), $file);
                                                
                                        // create record in il_plugin table (if not existing)
                                        ilPlugin::createPluginRecord($this->getComponentType(),
                                                $this->getComponentName(), $this->getSlotId(), $file);
                                        
                                        $pdata = $ilPluginAdmin->getAllData($this->getComponentType(),
                                                $this->getComponentName(), $this->getSlotId(), $file);

                                        $plugin["version"] = $pdata["version"];
                                        $plugin["id"] = $pdata["id"];
                                        $plugin["is_active"] = $pdata["is_active"];
                                        $plugin["inactive_reason"] = $pdata["inactive_reason"];
                                        $plugin["needs_update"] = $pdata["needs_update"];
                                        $plugin["ilias_min_version"] = $pdata["ilias_min_version"];
                                        $plugin["ilias_max_version"] = $pdata["ilias_max_version"];
                                        $plugin["activation_possible"] = $pdata["activation_possible"];
                                        $plugin["responsible"] = $pdata["responsible"];
                                        $plugin["responsible_mail"] = $pdata["responsible_mail"];
                                        
                                        $plugin["name"] = $file;
                                        $plugin["plugin_php_file_status"] = $this->checkPluginPhpFileAvailability($file);
                                        $plugin["class_file_status"] = $this->checkClassFileAvailability($file);
                                        $plugin["class_file"] = "class.il".$plugin["name"]."Plugin.php";
                                        
                                        $plugins[] = $plugin;
                                }
                        }
                }

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

                return $rec['id'];

                //global $ilDB;

                //$q = "SELECT * FROM il_pluginslot WHERE component = ".
                //      $ilDB->quote($a_ctype."/".$a_cname, "text").
                //      " AND name = ".$ilDB->quote($a_slot_name, "text");
                //$set = $ilDB->query($q);
                //$rec = $ilDB->fetchAssoc($set);
                //return $rec["id"];
        }

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

                return $rec['name'];

                //global $ilDB;

                //      $q = "SELECT * FROM il_pluginslot WHERE component = ".
                //              $ilDB->quote($a_ctype."/".$a_cname, "text").
                //      " AND id = ".$ilDB->quote($a_slot_id, "text");
                //$set = $ilDB->query($q);
                //$rec = $ilDB->fetchAssoc($set);
                //return $rec["name"];
        }

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

                //global $ilDB;
                
                //$set = $ilDB->query("SELECT * FROM il_pluginslot ");
                //$slots = array();
                //while ($rec  = $ilDB->fetchAssoc($set))
                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;
        }
        
}
?>