ilPluginSlot Class Reference

Plugin Slot. More...

Collaboration diagram for ilPluginSlot:

Public Member Functions
	__construct ($a_c_type, $a_c_name, $a_slot_id)
	Constructor. More...
	read ()
	Read properties from DB. More...
	setComponentType ($a_componenttype)
	Set Component Type. More...
	getComponentType ()
	Get Component Type. More...
	setComponentName ($a_componentname)
	Set Component Name. More...
	getComponentName ()
	Get Component Name. More...
	setSlotId ($a_slotid)
	Set Slot ID. More...
	getSlotId ()
	Get Slot ID. More...
	setSlotName ($a_slotname)
	Set Slot Name. More...
	getSlotName ()
	Get Slot Name. More...
	getPluginsDirectory ()
	Get directory of. More...
	getPluginPhpFileName ($a_plugin_name)
	Get File name for plugin.php. More...
	checkPluginPhpFileAvailability ($a_plugin_name)
	Check whether plugin.php file is available for plugin or not. More...
	getPluginClassFileName ($a_plugin_name)
	Get Class File name for plugin. More...
	checkClassFileAvailability ($a_plugin_name)
	Check whether Plugin class file is available for plugin or not. More...
	getPrefix ()
	Get slot prefix, used for lang vars and db tables. More...
	getPluginsInformation ()
	Get information an all plugins and their status. More...
	getPluginInformationFor (string $name)
	getActivePlugins ()
	Get active plugins of slot. More...

Static Public Member Functions
static	_getPluginsDirectory ($a_ctype, $a_cname, $a_slot_id)
	Get plugins directory. More...
static	lookupSlotId ($a_ctype, $a_cname, $a_slot_name)
	Lookup slot ID for component and slot name. More...
static	lookupSlotName ($a_ctype, $a_cname, $a_slot_id)
	Lookup slot name for component and slot id. More...
static	getAllSlots ()
	Get all plugin slots. More...
static	getAvailableSlots ()
	Get all plugin slots where plugins are available. More...

Protected Member Functions
	readPluginInformation (string $pl_dir, string $file)

Protected Attributes
	$prefix = ""

Detailed Description

Plugin Slot.

A plugin slot defines an interface for a set of plugins that share the same characteristics

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 19 of file class.ilPluginSlot.php.

Constructor & Destructor Documentation

__construct()

ilPluginSlot::__construct	(		$a_c_type,
			$a_c_name,
			$a_slot_id
	)

Constructor.

Definition at line 26 of file class.ilPluginSlot.php.

References read(), setComponentName(), setComponentType(), and setSlotId().

    {
        $this->setComponentType($a_c_type);
        $this->setComponentName($a_c_name);
        $this->setSlotId($a_slot_id);
        
        if ($a_slot_id != "") {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

_getPluginsDirectory()

static ilPluginSlot::_getPluginsDirectory (   $a_ctype,   $a_cname,   $a_slot_id  )

static

Get plugins directory.

Definition at line 139 of file class.ilPluginSlot.php.

References lookupSlotName().

Referenced by ilPlugin\_getDirectory().

    {
        return "./Customizing/global/plugins/" . $a_ctype .
            "/" . $a_cname . "/" . ilPluginSlot::lookupSlotName($a_ctype, $a_cname, $a_slot_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkClassFileAvailability()

ilPluginSlot::checkClassFileAvailability

(

$a_plugin_name

)

Check whether Plugin class file is available for plugin or not.

Definition at line 179 of file class.ilPluginSlot.php.

References getPluginClassFileName().

Referenced by readPluginInformation().

    {
        if (@is_file($this->getPluginClassFileName($a_plugin_name))) {
            return true;
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPluginPhpFileAvailability()

ilPluginSlot::checkPluginPhpFileAvailability

(

$a_plugin_name

)

Check whether plugin.php file is available for plugin or not.

Definition at line 158 of file class.ilPluginSlot.php.

References getPluginPhpFileName().

Referenced by readPluginInformation().

    {
        if (@is_file($this->getPluginPhpFileName($a_plugin_name))) {
            return true;
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActivePlugins()

ilPluginSlot::getActivePlugins

(

)

Get active plugins of slot.

Definition at line 317 of file class.ilPluginSlot.php.

References $DIC, getComponentName(), getComponentType(), and getSlotId().

    {
        global $DIC;
        $ilPluginAdmin = $DIC['ilPluginAdmin'];
        
        return $ilPluginAdmin->getActivePluginsForSlot(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId()
        );
    }

Here is the call graph for this function:

getAllSlots()

static ilPluginSlot::getAllSlots ( )

static

Get all plugin slots.

Definition at line 333 of file class.ilPluginSlot.php.

References ilCachedComponentData\getInstance().

Referenced by ilObjLanguage\refreshPlugins().

    {
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailableSlots()

static ilPluginSlot::getAvailableSlots ( )

static

Get all plugin slots where plugins are available.

Definition at line 355 of file class.ilPluginSlot.php.

References ilCachedComponentData\getInstance().

Referenced by ilPluginsOverviewTableFilterGUI\__construct().

                                               : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getComponentName()

ilPluginSlot::getComponentName

(

)

Get Component Name.

Returns

string Component Name

Definition at line 82 of file class.ilPluginSlot.php.

Referenced by getActivePlugins(), getPluginsDirectory(), getPrefix(), and readPluginInformation().

    {
        return $this->componentname;
    }

Here is the caller graph for this function:

getComponentType()

ilPluginSlot::getComponentType

(

)

Get Component Type.

Returns

string Component Type

Definition at line 62 of file class.ilPluginSlot.php.

Referenced by getActivePlugins(), getPluginsDirectory(), getPrefix(), and readPluginInformation().

    {
        return $this->componenttype;
    }

Here is the caller graph for this function:

getPluginClassFileName()

ilPluginSlot::getPluginClassFileName

(

$a_plugin_name

)

Get Class File name for plugin.

Definition at line 170 of file class.ilPluginSlot.php.

References getPluginsDirectory().

Referenced by checkClassFileAvailability(), and readPluginInformation().

    {
        return $this->getPluginsDirectory() . "/" .
            $a_plugin_name . "/classes/class.il" . $a_plugin_name . "Plugin.php";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginInformationFor()

ilPluginSlot::getPluginInformationFor

(

string

$name

)

Definition at line 234 of file class.ilPluginSlot.php.

References getPluginsDirectory(), and readPluginInformation().

                                                          : ?array
    {
        $pl_dir = $this->getPluginsDirectory();

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

Here is the call graph for this function:

getPluginPhpFileName()

ilPluginSlot::getPluginPhpFileName

(

$a_plugin_name

)

Get File name for plugin.php.

Definition at line 149 of file class.ilPluginSlot.php.

References getPluginsDirectory().

Referenced by checkPluginPhpFileAvailability().

    {
        return $this->getPluginsDirectory() . "/" .
            $a_plugin_name . "/plugin.php";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginsDirectory()

ilPluginSlot::getPluginsDirectory

(

)

Get directory of.

Definition at line 130 of file class.ilPluginSlot.php.

References getComponentName(), getComponentType(), and getSlotName().

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), getPluginClassFileName(), getPluginInformationFor(), getPluginPhpFileName(), and getPluginsInformation().

    {
        return "./Customizing/global/plugins/" . $this->getComponentType() .
            "/" . $this->getComponentName() . "/" . $this->getSlotName();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginsInformation()

ilPluginSlot::getPluginsInformation

(

)

Get information an all plugins and their status.

Definition at line 208 of file class.ilPluginSlot.php.

References XapiProxy\$plugin, getPluginsDirectory(), and readPluginInformation().

    {
        // 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;
    }

Here is the call graph for this function:

getPrefix()

ilPluginSlot::getPrefix

(

)

Get slot prefix, used for lang vars and db tables.

Needs plugin id appended.

Definition at line 192 of file class.ilPluginSlot.php.

References $prefix, getComponentName(), getComponentType(), getSlotId(), and ilComponent\lookupId().

    {
        if ($this->prefix == "") {
            $this->prefix =
                ilComponent::lookupId(
                    $this->getComponentType(),
                    $this->getComponentName()
                ) . "_" . $this->getSlotId();
        }
            
        return $this->prefix;
    }

Here is the call graph for this function:

getSlotId()

ilPluginSlot::getSlotId

(

)

Get Slot ID.

Returns

string Slot ID

Definition at line 102 of file class.ilPluginSlot.php.

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), getActivePlugins(), getPrefix(), read(), and readPluginInformation().

    {
        return $this->slotid;
    }

Here is the caller graph for this function:

getSlotName()

ilPluginSlot::getSlotName

(

)

Get Slot Name.

Returns

string Slot Name

Definition at line 122 of file class.ilPluginSlot.php.

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), and getPluginsDirectory().

    {
        return $this->slotname;
    }

Here is the caller graph for this function:

lookupSlotId()

static ilPluginSlot::lookupSlotId (   $a_ctype,   $a_cname,   $a_slot_name  )

static

Lookup slot ID for component and slot name.

Definition at line 295 of file class.ilPluginSlot.php.

References ilCachedComponentData\getInstance().

    {
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookupPluginSlotByName($a_slot_name);

        return $rec['id'];
    }

Here is the call graph for this function:

lookupSlotName()

static ilPluginSlot::lookupSlotName (   $a_ctype,   $a_cname,   $a_slot_id  )

static

Lookup slot name for component and slot id.

Definition at line 306 of file class.ilPluginSlot.php.

References ilCachedComponentData\getInstance().

Referenced by ilPluginDBUpdate\__construct(), _getPluginsDirectory(), ilPluginAdmin\getPluginData(), ilPlugin\getPluginObject(), and ilObjComponentSettingsGUI\showPlugin().

    {
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookupPluginSlotById($a_slot_id);

        return $rec['name'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilPluginSlot::read

(

)

Read properties from DB.

Definition at line 40 of file class.ilPluginSlot.php.

References ilCachedComponentData\getInstance(), getSlotId(), and setSlotName().

Referenced by __construct().

    {
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookupPluginSlotById($this->getSlotId());
        $this->setSlotName($rec["name"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readPluginInformation()

ilPluginSlot::readPluginInformation ( string  $pl_dir, string  $file  )

protected

Definition at line 241 of file class.ilPluginSlot.php.

References $DIC, XapiProxy\$plugin, checkClassFileAvailability(), checkPluginPhpFileAvailability(), ilPlugin\createPluginRecord(), getComponentName(), getComponentType(), getPluginClassFileName(), getSlotId(), and ilPlugin\lookupStoredData().

Referenced by getPluginInformationFor(), and getPluginsInformation().

                                                                           : ?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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setComponentName()

ilPluginSlot::setComponentName

(

$a_componentname

)

Set Component Name.

Parameters

string

$a_componentname

Component Name

Definition at line 72 of file class.ilPluginSlot.php.

Referenced by __construct().

    {
        $this->componentname = $a_componentname;
    }

Here is the caller graph for this function:

setComponentType()

ilPluginSlot::setComponentType

(

$a_componenttype

)

Set Component Type.

Parameters

string

$a_componenttype

Component Type

Definition at line 52 of file class.ilPluginSlot.php.

Referenced by __construct().

    {
        $this->componenttype = $a_componenttype;
    }

Here is the caller graph for this function:

setSlotId()

ilPluginSlot::setSlotId

(

$a_slotid

)

Set Slot ID.

Parameters

string

$a_slotid

Slot ID

Definition at line 92 of file class.ilPluginSlot.php.

Referenced by __construct().

    {
        $this->slotid = $a_slotid;
    }

Here is the caller graph for this function:

setSlotName()

ilPluginSlot::setSlotName

(

$a_slotname

)

Set Slot Name.

Parameters

string

$a_slotname

Slot Name

Definition at line 112 of file class.ilPluginSlot.php.

Referenced by read().

    {
        $this->slotname = $a_slotname;
    }

Here is the caller graph for this function:

Field Documentation

$prefix

ilPluginSlot::$prefix = ""

protected

Definition at line 21 of file class.ilPluginSlot.php.

Referenced by getPrefix().

---

The documentation for this class was generated from the following file:

• Services/Component/classes/class.ilPluginSlot.php