ilPlugin Class Reference

Inheritance diagram for ilPlugin:

Collaboration diagram for ilPlugin:

Public Member Functions
	__construct ()
	getComponentType ()
	Get Component Type. More...
	getComponentName ()
	Get Component Name. More...
	getSlot ()
	Get Slot Name. More...
	getSlotId ()
	Get Slot ID. More...
	getPluginName ()
	Get Plugin Name. More...
	getId ()
	Get Id. More...
	getLastUpdateVersion ()
	Get Version of last update. More...
	getVersion ()
	Get Current Version (from plugin.php file). More...
	getIliasMinVersion ()
	Get Required ILIAS min. More...
	getIliasMaxVersion ()
	Get Required ILIAS max. More...
	getActive ()
	Get Active. More...
	setDBVersion ($a_dbversion)
	Set DB Version. More...
	getDBVersion ()
	Get DB Version. More...
	writeDBVersion ($a_dbversion)
	Write DB version to database. More...
	getDirectory ()
	Get Plugin Directory. More...
	includeClass ($a_class_file_name)
	Include (once) a class file. More...
	getPrefix ()
	Get plugin prefix, used for lang vars. More...
	getTablePrefix ()
	Get db table plugin prefix. More...
	updateLanguages ($a_lang_keys=null)
	updateDatabase ()
	Update database. More...
	loadLanguageModule ()
	Load language module for plugin. More...
	txt ($a_var)
	Get Language Variable (prefix will be prepended automatically) More...
	getTemplate ($a_template, $a_par1=true, $a_par2=true)
	Get template from plugin. More...
	getImagePath ($a_img)
	Get image path. More...
	getStyleSheetLocation ($a_css_file)
	Get css file location. More...
	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	Add template content to placeholder variable. More...
	isActive ()
	Check whether plugin is active. More...
	needsUpdate ()
	Check whether update is needed. More...
	install ()
	Install. More...
	activate ()
	Activate. More...
	deactivate ()
	Deactivate. More...
	uninstall ()
	update ()
	Update plugin. More...

Static Public Member Functions
static	_getDirectory ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin directory. More...
static	getAvailableLangFiles ($a_lang_directory)
	Get array of all language files in the plugin. More...
static	hasConfigureClass ($a_slot_dir, $a_name)
	Has the plugin a configure class? More...
static	getConfigureClassName ($a_name)
	Get plugin configure class name. More...
static	getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname)
	Get DB update script filename (full path) More...
static	lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var)
	Lookup language text. More...
static	langExitsById ($pluginId, $langVar)
	Is searched lang var available in plugin lang files. More...
static	_getImagePath ( $a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
	Get image path. More...
static	createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
static	getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get record from il_plugin table. More...
static	getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin object. More...
static	lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Lookup information data in il_plugin. More...
static	getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get all active plugin names for a slot. More...
static	getActivePluginIdsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get All active plugin ids for a slot. More...
static	lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
	Lookup name for id. More...
static	lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name)
	Lookup id for name. More...

Protected Member Functions
	setSlotObject ($a_slot)
	Set Plugin Slot. More...
	getSlotObject ()
	Get Plugin Slot. More...
	getClassesDirectory ()
	Get Plugin's classes Directory. More...
	getLanguageDirectory ()
	Get Plugin's language Directory. More...
	slotInit ()
	Object initialization done by slot. More...
	init ()
	Object initialization. More...
	afterInstall ()
	After install processing. More...
	beforeActivation ()
	Before activation processing. More...
	afterActivation ()
	After activation processing. More...
	afterDeactivation ()
	After deactivation processing. More...
	beforeUninstall ()
	afterUninstall ()
	readEventListening ()
	Read the event listening definitions from the plugin.xml (if file exists) More...
	clearEventListening ()
	Clear the entries of this plugin in the event handling table. More...
	beforeUpdate ()
	Before update processing. More...
	afterUpdate ()
	After update processing. More...

Protected Attributes
	$lang_initialised = false
	$id = ''

Private Member Functions
	setId ($a_id)
	Set Id. More...
	setLastUpdateVersion ($a_lastupdateversion)
	Set Version of last update. More...
	setVersion ($a_version)
	Set Current Version (from plugin.php file). More...
	setIliasMinVersion ($a_iliasminversion)
	Set Required ILIAS min. More...
	setIliasMaxVersion ($a_iliasmaxversion)
	Set Required ILIAS max. More...
	setActive ($a_active)
	Set Active. More...
	__init ()
	Default initialization. More...

Detailed Description

Definition at line 16 of file class.ilPlugin.php.

Constructor & Destructor Documentation

__construct()

ilPlugin::__construct

(

)

Reimplemented in ilRepositoryObjectPlugin.

Definition at line 28 of file class.ilPlugin.php.

    {
        $this->__init();
    }

References __init().

Here is the call graph for this function:

Member Function Documentation

__init()

ilPlugin::__init ( )

private

Default initialization.

Definition at line 659 of file class.ilPlugin.php.

    {
        global $ilDB, $lng, $ilPluginAdmin;
 
        // read/set basic data
        $rec = ilPlugin::getPluginRecord(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        );
        $this->setLastUpdateVersion($rec["last_update_version"]);
        $this->setDBVersion($rec["db_version"]);
        $this->setActive($rec["active"]);
 
        // get id
        $this->setId($ilPluginAdmin->getId(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        ));
 
        // get version
        $this->setVersion($ilPluginAdmin->getVersion(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        ));
 
        // get ilias min version
        $this->setIliasMinVersion($ilPluginAdmin->getIliasMinVersion(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        ));
 
        // get ilias max version
        $this->setIliasMaxVersion($ilPluginAdmin->getIliasMaxVersion(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        ));
 
        // get slot object
        $this->setSlotObject(new ilPluginSlot(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId()
        ));
 
        // load language module
 
        // Fix for authentication plugins
        $this->loadLanguageModule();
 
        // call slot and plugin init methods
        $this->slotInit();
        $this->init();
    }

References $ilDB, $lng, getComponentName(), getComponentType(), getPluginName(), getPluginRecord(), getSlotId(), init(), loadLanguageModule(), setActive(), setDBVersion(), setId(), setIliasMaxVersion(), setIliasMinVersion(), setLastUpdateVersion(), setSlotObject(), setVersion(), and slotInit().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

_getDirectory()

static ilPlugin::_getDirectory (   $a_ctype,   $a_cname,   $a_slot_id,   $a_pname  )

static

Get plugin directory.

Definition at line 272 of file class.ilPlugin.php.

    {
        include_once "Services/Component/classes/class.ilPluginSlot.php";
        return ilPluginSlot::_getPluginsDirectory($a_ctype, $a_cname, $a_slot_id) . "/" . $a_pname;
    }

References ilPluginSlot\_getPluginsDirectory().

Referenced by _getImagePath(), and ilObjectDefinition\parsePluginData().

Here is the call graph for this function:

Here is the caller graph for this function:

_getImagePath()

static ilPlugin::_getImagePath (   $a_ctype,   $a_cname,   $a_slot_id,   $a_pname,   $a_img  )

static

Get image path.

Definition at line 553 of file class.ilPlugin.php.

      {
        $d2 = ilComponent::lookupId($a_ctype, $a_cname) . "_" . $a_slot_id . "_" .
            ilPlugin::lookupIdForName($a_ctype, $a_cname, $a_slot_id, $a_pname);
 
        $img = ilUtil::getImagePath($d2 . "/" . $a_img);
        if (is_int(strpos($img, "Customizing"))) {
            return $img;
        }
 
        $d = ilPlugin::_getDirectory($a_ctype, $a_cname, $a_slot_id, $a_pname);
        return $d . "/templates/images/" . $a_img;
    }

References $d, $img, _getDirectory(), ilUtil\getImagePath(), ilComponent\lookupId(), and lookupIdForName().

Referenced by ilOrgUnitExtensionPlugin\_getIcon(), ilRepositoryObjectPlugin\_getIcon(), and getImagePath().

Here is the call graph for this function:

Here is the caller graph for this function:

activate()

ilPlugin::activate

(

)

Activate.

Definition at line 792 of file class.ilPlugin.php.

    {
        global $lng, $ilDB;
 
        ilCachedComponentData::flush();
 
        $result = true;
 
        // check whether update is necessary
        if ($this->needsUpdate()) {
            //$result = $this->isUpdatePossible();
 
            // do update
            if ($result === true) {
                $result = $this->update();
            }
        }
        if ($result === true) {
            $result = $this->beforeActivation();
            // activate plugin
            if ($result === true) {
                $q = "UPDATE il_plugin SET active = " . $ilDB->quote(1, "integer") .
                    " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
                    " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
                    " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
                    " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
                $ilDB->manipulate($q);
                $this->afterActivation();
            }
        }
        ilCachedComponentData::flush();
        return $result;
    }

References $ilDB, $lng, $result, afterActivation(), beforeActivation(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getPluginName(), getSlotId(), needsUpdate(), and update().

Here is the call graph for this function:

addBlockFile()

ilPlugin::addBlockFile	(		$a_tpl,
			$a_var,
			$a_block,
			$a_tplname
	)

Add template content to placeholder variable.

Definition at line 605 of file class.ilPlugin.php.

    {
        $a_tpl->addBlockFile(
            $a_var,
            $a_block,
            $this->getDirectory() . "/templates/" . $a_tplname
        );
    }

References getDirectory().

Here is the call graph for this function:

afterActivation()

ilPlugin::afterActivation ( )

protected

After activation processing.

Reimplemented in ilCachedPlugin.

Definition at line 850 of file class.ilPlugin.php.

    {
    }

Referenced by activate().

Here is the caller graph for this function:

afterDeactivation()

ilPlugin::afterDeactivation ( )

protected

After deactivation processing.

Reimplemented in ilCachedPlugin.

Definition at line 881 of file class.ilPlugin.php.

    {
    }

Referenced by deactivate().

Here is the caller graph for this function:

afterInstall()

ilPlugin::afterInstall ( )

protected

After install processing.

Returns

void

Definition at line 832 of file class.ilPlugin.php.

    {
    }

Referenced by install().

Here is the caller graph for this function:

afterUninstall()

ilPlugin::afterUninstall ( )

protected

Definition at line 928 of file class.ilPlugin.php.

    {
        // plugin-specific
    }

Referenced by uninstall().

Here is the caller graph for this function:

afterUpdate()

ilPlugin::afterUpdate ( )

protected

After update processing.

Reimplemented in ilCachedPlugin.

Definition at line 1036 of file class.ilPlugin.php.

    {
    }

Referenced by update().

Here is the caller graph for this function:

beforeActivation()

ilPlugin::beforeActivation ( )

protected

Before activation processing.

Reimplemented in ilCachedPlugin, and ilRepositoryObjectPlugin.

Definition at line 839 of file class.ilPlugin.php.

    {
        return true;    // false would indicate that anything went wrong
        // activation would not proceed
        // throw an exception in this case
        //throw new ilPluginException($lng->txt(""));
    }

Referenced by activate().

Here is the caller graph for this function:

beforeUninstall()

ilPlugin::beforeUninstall ( )

protected

Reimplemented in ilRepositoryObjectPlugin.

Definition at line 886 of file class.ilPlugin.php.

    {
        // plugin-specific
        // false would indicate that anything went wrong
        return true;
    }

Referenced by uninstall().

Here is the caller graph for this function:

beforeUpdate()

ilPlugin::beforeUpdate ( )

protected

Before update processing.

Reimplemented in ilCachedPlugin.

Definition at line 1025 of file class.ilPlugin.php.

    {
        return true;    // false would indicate that anything went wrong
        // update would not proceed
        // throw an exception in this case
        //throw new ilPluginException($lng->txt(""));
    }

Referenced by update().

Here is the caller graph for this function:

clearEventListening()

ilPlugin::clearEventListening ( )

protected

Clear the entries of this plugin in the event handling table.

Definition at line 1010 of file class.ilPlugin.php.

    {
        $reader = new ilPluginReader(
            $this->getDirectory() . '/plugin.xml',
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        );
        $reader->clearEvents();
    }

References $reader, getComponentName(), getComponentType(), getDirectory(), getPluginName(), and getSlotId().

Referenced by uninstall().

Here is the call graph for this function:

Here is the caller graph for this function:

createPluginRecord()

static ilPlugin::createPluginRecord (   $a_ctype,   $a_cname,   $a_slot_id,   $a_pname  )

static

Parameters

$a_ctype
$a_cname
$a_slot_id
$a_pname

@description Create plugin record

Definition at line 623 of file class.ilPlugin.php.

    {
        global $ilDB;
 
        ilCachedComponentData::flush();
 
        $q = "INSERT INTO il_plugin (component_type, component_name, slot_id, name)" .
            " VALUES (" . $ilDB->quote($a_ctype, "text") . "," .
            $ilDB->quote($a_cname, "text") . "," .
            $ilDB->quote($a_slot_id, "text") . "," .
            $ilDB->quote($a_pname, "text") . ")";
 
        $ilDB->manipulate($q);
    }

References $ilDB, and ilCachedComponentData\flush().

Referenced by ilPluginSlot\getPluginsInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

deactivate()

ilPlugin::deactivate

(

)

Deactivate.

Definition at line 857 of file class.ilPlugin.php.

    {
        global $ilDB;
 
        ilCachedComponentData::flush();
 
        $result = true;
 
        $q = "UPDATE il_plugin SET active = " . $ilDB->quote(0, "integer") .
            " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
            " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
            " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
            " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
        $ilDB->manipulate($q);
        $this->afterDeactivation();
 
        return $result;
    }

References $ilDB, $result, afterDeactivation(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getPluginName(), and getSlotId().

Here is the call graph for this function:

getActive()

ilPlugin::getActive

(

)

Get Active.

Returns

boolean Active

Definition at line 193 of file class.ilPlugin.php.

    {
        return $this->active;
    }

getActivePluginIdsForSlot()

static ilPlugin::getActivePluginIdsForSlot (   $a_ctype,   $a_cname,   $a_slot_id  )

static

Get All active plugin ids for a slot.

Parameters

$a_ctype
$a_cname
$a_slot_id

Returns

array

Definition at line 1131 of file class.ilPlugin.php.

    {
        global $ilPluginAdmin;
 
        $plugins = array();
        $cached_component = ilCachedComponentData::getInstance();
        $lookupActivePluginsBySlotId = $cached_component->lookupActivePluginsBySlotId($a_slot_id);
        foreach ($lookupActivePluginsBySlotId as $rec) {
            if ($ilPluginAdmin->isActive($a_ctype, $a_cname, $a_slot_id, $rec["name"])) {
                $plugins[] = $rec["plugin_id"];
            }
        }
 
        return $plugins;
    }

References ilCachedComponentData\getInstance().

Here is the call graph for this function:

getActivePluginsForSlot()

static ilPlugin::getActivePluginsForSlot (   $a_ctype,   $a_cname,   $a_slot_id  )

static

Get all active plugin names for a slot.

Definition at line 1106 of file class.ilPlugin.php.

    {
        global $ilPluginAdmin;
 
        $plugins = array();
 
        $cached_component = ilCachedComponentData::getInstance();
 
        $lookupActivePluginsBySlotId = $cached_component->lookupActivePluginsBySlotId($a_slot_id);
        foreach ($lookupActivePluginsBySlotId as $rec) {
            if ($ilPluginAdmin->isActive($a_ctype, $a_cname, $a_slot_id, $rec["name"])) {
                $plugins[] = $rec["name"];
            }
        }
 
        return $plugins;
    }

References ilCachedComponentData\getInstance().

Referenced by ilPluginAdmin\getActivePluginsForSlot().

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailableLangFiles()

static ilPlugin::getAvailableLangFiles (   $a_lang_directory )

static

Get array of all language files in the plugin.

Definition at line 310 of file class.ilPlugin.php.

    {
        $langs = array();
 
        if (!@is_dir($a_lang_directory)) {
            return array();
        }
 
        $dir = opendir($a_lang_directory);
        while ($file = readdir($dir)) {
            if ($file != "." and
                $file != "..") {
                // directories
                if (@is_file($a_lang_directory . "/" . $file)) {
                    if (substr($file, 0, 6) == "ilias_" &&
                        substr($file, strlen($file) - 5) == ".lang") {
                        $langs[] = array("key" => substr($file, 6, 2), "file" => $file,
                            "path" => $a_lang_directory . "/" . $file);
                    }
                }
            }
        }
 
        return $langs;
    }

References $file.

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), ilObjComponentSettingsGUI\showPlugin(), and updateLanguages().

Here is the caller graph for this function:

getClassesDirectory()

ilPlugin::getClassesDirectory ( )

protected

Get Plugin's classes Directory.

Returns

object classes directory

Definition at line 284 of file class.ilPlugin.php.

    {
        return $this->getDirectory() . "/classes";
    }

References getDirectory().

Referenced by includeClass().

Here is the call graph for this function:

Here is the caller graph for this function:

getComponentName()

ilPlugin::getComponentName ( )

abstract

Get Component Name.

Must be overwritten in plugin class of plugin slot.

Returns

string Component Name

Reimplemented in ilCloudHookPlugin, ilDclFieldTypePlugin, ilOrgUnitExtensionPlugin, ilOrgUnitTypeHookPlugin, ilStudyProgrammeTypeHookPlugin, ilSurveyQuestionsPlugin, ilTestExportPlugin, ilTestSignaturePlugin, ilQuestionsPlugin, ilAdvancedMDClaimingPlugin, ilAuthPlugin, ilShibbolethAuthenticationPlugin, ilAppointmentCustomGridPlugin, ilAppointmentCustomModalPlugin, ilPageComponentPlugin, ilCronHookPlugin, ilEventHookPlugin, ilLDAPPlugin, ilPDFRendererPlugin, ilPersonalDesktopHookPlugin, ilPreviewRendererPlugin, ilRepositoryObjectPlugin, ilUserInterfaceHookPlugin, ilUDFClaimingPlugin, ilSoapHookPlugin, and ilComplexGatewayPlugin.

Referenced by __init(), activate(), clearEventListening(), deactivate(), getImagePath(), getStyleSheetLocation(), install(), isActive(), needsUpdate(), readEventListening(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

getComponentType()

ilPlugin::getComponentType ( )

abstract

Get Component Type.

Must be overwritten in plugin class of plugin slot.

Returns

string Component Type

Reimplemented in ilCloudHookPlugin, ilDclFieldTypePlugin, ilOrgUnitExtensionPlugin, ilOrgUnitTypeHookPlugin, ilStudyProgrammeTypeHookPlugin, ilSurveyQuestionsPlugin, ilTestExportPlugin, ilTestSignaturePlugin, ilQuestionsPlugin, ilAdvancedMDClaimingPlugin, ilAuthPlugin, ilShibbolethAuthenticationPlugin, ilAppointmentCustomGridPlugin, ilAppointmentCustomModalPlugin, ilPageComponentPlugin, ilCronHookPlugin, ilEventHookPlugin, ilLDAPPlugin, ilPDFRendererPlugin, ilPersonalDesktopHookPlugin, ilPreviewRendererPlugin, ilRepositoryObjectPlugin, ilUserInterfaceHookPlugin, ilUDFClaimingPlugin, ilSoapHookPlugin, and ilComplexGatewayPlugin.

Referenced by __init(), activate(), clearEventListening(), deactivate(), getImagePath(), getStyleSheetLocation(), install(), isActive(), needsUpdate(), readEventListening(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

getConfigureClassName()

static ilPlugin::getConfigureClassName (   $a_name )

static

Get plugin configure class name.

Parameters

return

Definition at line 358 of file class.ilPlugin.php.

    {
        return "il" . $a_name . "ConfigGUI";
    }

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), ilObjComponentSettingsGUI\showPlugin(), and update().

Here is the caller graph for this function:

getDBUpdateScriptName()

static ilPlugin::getDBUpdateScriptName (   $a_ctype,   $a_cname,   $a_slot_name,   $a_pname  )

static

Get DB update script filename (full path)

Returns

string DB Update script name

Definition at line 376 of file class.ilPlugin.php.

    {
        return "Customizing/global/plugins/" . $a_ctype . "/" . $a_cname . "/" .
        $a_slot_name . "/" . $a_pname . "/sql/dbupdate.php";
    }

Referenced by ilPluginDBUpdate\__construct(), and ilObjComponentSettingsGUI\showPlugin().

Here is the caller graph for this function:

getDBVersion()

ilPlugin::getDBVersion

(

)

Get DB Version.

Returns

int DB Version

Definition at line 233 of file class.ilPlugin.php.

    {
        return $this->dbversion;
    }

Referenced by writeDBVersion().

Here is the caller graph for this function:

getDirectory()

ilPlugin::getDirectory

(

)

Get Plugin Directory.

Returns

object Plugin Slot

Definition at line 264 of file class.ilPlugin.php.

    {
        return $this->getSlotObject()->getPluginsDirectory() . "/" . $this->getPluginName();
    }

References getPluginName(), and getSlotObject().

Referenced by addBlockFile(), clearEventListening(), getClassesDirectory(), getLanguageDirectory(), getStyleSheetLocation(), getTemplate(), readEventListening(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilPlugin::getId

(

)

Get Id.

Returns

string Id

Definition at line 93 of file class.ilPlugin.php.

    {
        return $this->id;
    }

References $id.

Referenced by ilRepositoryObjectPlugin\beforeActivation(), ilRepositoryObjectPlugin\beforeUninstall(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), getPrefix(), ilTestSignaturePlugin\handInFileForArchiving(), and install().

Here is the caller graph for this function:

getIliasMaxVersion()

ilPlugin::getIliasMaxVersion

(

)

Get Required ILIAS max.

release.

Returns

string Required ILIAS max. release

Definition at line 173 of file class.ilPlugin.php.

    {
        return $this->iliasmaxversion;
    }

getIliasMinVersion()

ilPlugin::getIliasMinVersion

(

)

Get Required ILIAS min.

release.

Returns

string Required ILIAS min. release

Definition at line 153 of file class.ilPlugin.php.

    {
        return $this->iliasminversion;
    }

getImagePath()

ilPlugin::getImagePath

(

$a_img

)

Get image path.

Definition at line 575 of file class.ilPlugin.php.

    {
        return self::_getImagePath(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName(),
            $a_img
        );
    }

References _getImagePath(), getComponentName(), getComponentType(), getPluginName(), and getSlotId().

Here is the call graph for this function:

getLanguageDirectory()

ilPlugin::getLanguageDirectory ( )

protected

Get Plugin's language Directory.

Returns

object classes directory

Definition at line 302 of file class.ilPlugin.php.

    {
        return $this->getDirectory() . "/lang";
    }

References getDirectory().

Referenced by updateLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

getLastUpdateVersion()

ilPlugin::getLastUpdateVersion

(

)

Get Version of last update.

Returns

string Version of last update

Definition at line 113 of file class.ilPlugin.php.

    {
        return $this->lastupdateversion;
    }

getPluginName()

ilPlugin::getPluginName ( )

abstract

Get Plugin Name.

Must be same as in class name il<Name>Plugin and must correspond to plugins subdirectory name.

Must be overwritten in plugin class of plugin

Returns

string Plugin Name

Referenced by __init(), activate(), clearEventListening(), deactivate(), getDirectory(), getImagePath(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), ilPreviewRendererPlugin\getRendererClassInstance(), getStyleSheetLocation(), ilPageComponentPlugin\getUIClassInstance(), ilUserInterfaceHookPlugin\getUIClassInstance(), install(), isActive(), needsUpdate(), readEventListening(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

getPluginObject()

static ilPlugin::getPluginObject (   $a_ctype,   $a_cname,   $a_slot_id,   $a_pname  )

static

Get plugin object.

Parameters

string	$a_ctype	IL_COMP_MODULE | IL_COMP_SERVICE
string	$a_cname	component name
string	$a_sname	plugin slot name
string	$a_pname	plugin name

Definition at line 1048 of file class.ilPlugin.php.

    {
        include_once("./Services/Component/classes/class.ilPluginSlot.php");
        $slot_name = ilPluginSlot::lookupSlotName($a_ctype, $a_cname, $a_slot_id);
 
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookCompId($a_ctype, $a_cname);
        if (!$rec) {
            return null;
        }
 
        $file = "./Customizing/global/plugins/" . $a_ctype . "/" .
            $a_cname . "/" . $slot_name . "/" .
            $a_pname . "/classes/class.il" . $a_pname . "Plugin.php";
 
        if (is_file($file)) {
            include_once($file);
            $class = "il" . $a_pname . "Plugin";
            $plugin = new $class();
            return $plugin;
        }
 
        return null;
    }

References $file, ilCachedComponentData\getInstance(), and ilPluginSlot\lookupSlotName().

Referenced by SurveyQuestion\_getQuestionTypeName(), assQuestion\_getQuestionTypeName(), ilObjQuestionPool\_getQuestionTypes(), ilObjSurveyQuestionPool\_getQuestiontypes(), ilObjSurveyQuestionPool\_getQuestionTypeTranslations(), SurveyQuestion\_includeClass(), ilObjComponentSettingsGUI\activatePlugin(), ilObjComponentSettingsGUI\confirmUninstallPlugin(), ilObjComponentSettingsGUI\deactivatePlugin(), ilObjTest\getAvailableQuestions(), ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldTypeByInstance(), ilOrgUnitExtension\getPlugin(), ilOrgUnitExtensionGUI\getPlugin(), ilOrgUnitExtensionListGUI\getPlugin(), ilObjectPlugin\getPlugin(), ilObjectPluginGUI\getPlugin(), ilObjectPluginListGUI\getPlugin(), ilPluginAdmin\getPluginObject(), ilObjQuestionPool\getQuestionTypeTranslations(), ilPluginAdmin\includeClass(), assQuestion\includePluginClass(), ilObjComponentSettingsGUI\installPlugin(), ilObjQuestionPool\isPluginActive(), ilObjectPlugin\loadRepoPlugin(), ilObjComponentSettingsGUI\refreshLanguages(), ilObjLanguage\refreshPlugins(), ilObjComponentSettingsGUI\uninstallPlugin(), ilObjComponentSettingsGUI\updatePlugin(), and ilObjQuestionPoolGUI\uploadQplObject().

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginRecord()

static ilPlugin::getPluginRecord (   $a_ctype,   $a_cname,   $a_slot_id,   $a_pname  )

static

Get record from il_plugin table.

Definition at line 642 of file class.ilPlugin.php.

    {
        $cached_component = ilCachedComponentData::getInstance();
        $rec = $cached_component->lookupPluginByName($a_pname);
 
        if ($rec['component_type'] == $a_ctype and $rec['component_name'] == $a_cname and $rec['slot_id'] == $a_slot_id) {
            return $rec;
        } else {
            include_once("./Services/Component/exceptions/class.ilPluginException.php");
            throw (new ilPluginException("No plugin record found for '" . $a_ctype . "', '" . $a_cname . "', '" . $a_slot_id . "', '" . $a_pname
                . "'."));
        }
    }

References ilCachedComponentData\getInstance().

Referenced by __init(), ilPluginAdmin\getPluginData(), ilCloudHookPlugin\getPluginTablePrefix(), and ilDclFieldTypePlugin\getPluginTablePrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

getPrefix()

ilPlugin::getPrefix

(

)

Get plugin prefix, used for lang vars.

Definition at line 366 of file class.ilPlugin.php.

    {
        return $this->getSlotObject()->getPrefix() . "_" . $this->getId();
    }

References getId(), and getSlotObject().

Referenced by getTablePrefix(), loadLanguageModule(), txt(), uninstall(), update(), and updateLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

getSlot()

ilPlugin::getSlot ( )

abstract

Get Slot Name.

Must be overwritten in plugin class of plugin slot.

Returns

string Slot Name

Reimplemented in ilCloudHookPlugin, ilDclFieldTypePlugin, ilOrgUnitExtensionPlugin, ilOrgUnitTypeHookPlugin, ilStudyProgrammeTypeHookPlugin, ilSurveyQuestionsPlugin, ilTestExportPlugin, ilTestSignaturePlugin, ilQuestionsPlugin, ilAdvancedMDClaimingPlugin, ilAuthPlugin, ilShibbolethAuthenticationPlugin, ilAppointmentCustomGridPlugin, ilAppointmentCustomModalPlugin, ilPageComponentPlugin, ilCronHookPlugin, ilEventHookPlugin, ilLDAPPlugin, ilPDFRendererPlugin, ilPersonalDesktopHookPlugin, ilPreviewRendererPlugin, ilRepositoryObjectPlugin, ilUserInterfaceHookPlugin, ilUDFClaimingPlugin, ilSoapHookPlugin, and ilComplexGatewayPlugin.

getSlotId()

ilPlugin::getSlotId ( )

abstract

Get Slot ID.

Must be overwritten in plugin class of plugin slot.

Returns

string Slot Id

Reimplemented in ilCloudHookPlugin, ilDclFieldTypePlugin, ilOrgUnitExtensionPlugin, ilOrgUnitTypeHookPlugin, ilStudyProgrammeTypeHookPlugin, ilSurveyQuestionsPlugin, ilTestExportPlugin, ilTestSignaturePlugin, ilQuestionsPlugin, ilAdvancedMDClaimingPlugin, ilAuthPlugin, ilShibbolethAuthenticationPlugin, ilAppointmentCustomGridPlugin, ilAppointmentCustomModalPlugin, ilPageComponentPlugin, ilCronHookPlugin, ilEventHookPlugin, ilLDAPPlugin, ilPDFRendererPlugin, ilPersonalDesktopHookPlugin, ilPreviewRendererPlugin, ilRepositoryObjectPlugin, ilUserInterfaceHookPlugin, ilUDFClaimingPlugin, ilSoapHookPlugin, and ilComplexGatewayPlugin.

Referenced by __init(), activate(), clearEventListening(), deactivate(), getImagePath(), getStyleSheetLocation(), install(), isActive(), needsUpdate(), readEventListening(), uninstall(), update(), updateDatabase(), and writeDBVersion().

Here is the caller graph for this function:

getSlotObject()

ilPlugin::getSlotObject ( )

protected

Get Plugin Slot.

Returns

object Plugin Slot

Definition at line 213 of file class.ilPlugin.php.

    {
        return $this->slot;
    }

Referenced by getDirectory(), ilCloudHookPlugin\getPluginTablePrefix(), ilDclFieldTypePlugin\getPluginTablePrefix(), and getPrefix().

Here is the caller graph for this function:

getStyleSheetLocation()

ilPlugin::getStyleSheetLocation

(

$a_css_file

)

Get css file location.

Definition at line 589 of file class.ilPlugin.php.

    {
        $d2 = ilComponent::lookupId($this->getComponentType(), $this->getComponentName()) . "_" . $this->getSlotId() . "_" .
            ilPlugin::lookupIdForName($this->getComponentType(), $this->getComponentName(), $this->getSlotId(), $this->getPluginName());
 
        $css = ilUtil::getStyleSheetLocation("output", $a_css_file, $d2);
        if (is_int(strpos($css, "Customizing"))) {
            return $css;
        }
 
        return $this->getDirectory() . "/templates/" . $a_css_file;
    }

References getComponentName(), getComponentType(), getDirectory(), getPluginName(), getSlotId(), ilUtil\getStyleSheetLocation(), ilComponent\lookupId(), and lookupIdForName().

Here is the call graph for this function:

getTablePrefix()

ilPlugin::getTablePrefix

(

)

Get db table plugin prefix.

Definition at line 385 of file class.ilPlugin.php.

    {
        return $this->getPrefix();
    }

References getPrefix().

Referenced by updateDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplate()

ilPlugin::getTemplate	(		$a_template,
			$a_par1 = true,
			$a_par2 = true
	)

Get template from plugin.

Definition at line 543 of file class.ilPlugin.php.

    {
        $tpl = new ilTemplate($this->getDirectory() . "/templates/" . $a_template, $a_par1, $a_par2);
 
        return $tpl;
    }

References $tpl, and getDirectory().

Here is the call graph for this function:

getVersion()

ilPlugin::getVersion

(

)

Get Current Version (from plugin.php file).

Returns

string Current Version (from plugin.php file)

Definition at line 133 of file class.ilPlugin.php.

    {
        return $this->version;
    }

References $version.

Referenced by update().

Here is the caller graph for this function:

hasConfigureClass()

static ilPlugin::hasConfigureClass (   $a_slot_dir,   $a_name  )

static

Has the plugin a configure class?

Parameters

string	slot directory
string	plugin name

Returns

boolean true/false

Definition at line 343 of file class.ilPlugin.php.

    {
        if (is_file($a_slot_dir . "/" .
            $a_name . "/classes/class.il" . $a_name . "ConfigGUI.php")) {
            return true;
        }
        return false;
    }

Referenced by ilPluginsOverviewTableGUI\gatherPluginData(), and ilObjComponentSettingsGUI\showPlugin().

Here is the caller graph for this function:

includeClass()

ilPlugin::includeClass

(

$a_class_file_name

)

Include (once) a class file.

Definition at line 292 of file class.ilPlugin.php.

    {
        include_once($this->getClassesDirectory() . "/" . $a_class_file_name);
    }

References getClassesDirectory().

Referenced by ilPreviewRendererPlugin\getRendererClassInstance(), ilPageComponentPlugin\getUIClassInstance(), and ilUserInterfaceHookPlugin\getUIClassInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ilPlugin::init ( )

protected

Object initialization.

Can be overwritten by plugin class (and should be made protected)

Reimplemented in ilCachedPlugin.

Definition at line 735 of file class.ilPlugin.php.

    {
    }

Referenced by __init().

Here is the caller graph for this function:

install()

ilPlugin::install

(

)

Install.

Returns

void

Definition at line 774 of file class.ilPlugin.php.

    {
        global $ilDB;
 
        ilCachedComponentData::flush();
        $q = "UPDATE il_plugin SET plugin_id = " . $ilDB->quote($this->getId(), "text") .
                    " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
                    " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
                    " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
                    " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
        $ilDB->manipulate($q);
        $this->afterInstall();
    }

References $ilDB, afterInstall(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getId(), getPluginName(), and getSlotId().

Here is the call graph for this function:

isActive()

ilPlugin::isActive

(

)

Check whether plugin is active.

Definition at line 742 of file class.ilPlugin.php.

    {
        global $ilPluginAdmin;
 
        return $ilPluginAdmin->isActive(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        );
    }

References getComponentName(), getComponentType(), getPluginName(), and getSlotId().

Here is the call graph for this function:

langExitsById()

static ilPlugin::langExitsById (   $pluginId,   $langVar  )

static

Is searched lang var available in plugin lang files.

Parameters

int	$pluginId
string	$langVar

Returns

bool

Definition at line 529 of file class.ilPlugin.php.

    {
        global $lng;
 
        $pl = ilObjectPlugin::getRepoPluginObjectByType($pluginId);
        $pl->loadLanguageModule();
 
        return $lng->exists($pl->getPrefix() . "_" . $langVar);
    }

References $lng, and ilObjectPlugin\getRepoPluginObjectByType().

Referenced by ilObjectRolePermissionTableGUI\fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

loadLanguageModule()

ilPlugin::loadLanguageModule

(

)

Load language module for plugin.

Definition at line 489 of file class.ilPlugin.php.

    {
        global $lng;
 
        if (!$this->lang_initialised && is_object($lng)) {
            $lng->loadLanguageModule($this->getPrefix());
            $this->lang_initialised = true;
        }
    }

References $lng, and getPrefix().

Referenced by __init(), and txt().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupIdForName()

static ilPlugin::lookupIdForName (   $a_ctype,   $a_cname,   $a_slot_id,   $a_plugin_name  )

static

Lookup id for name.

Reimplemented in ilCachedPlugin.

Definition at line 1169 of file class.ilPlugin.php.

    {
        global $ilDB;
 
        $q = "SELECT plugin_id FROM il_plugin " .
            " WHERE component_type = " . $ilDB->quote($a_ctype, "text") .
            " AND component_name = " . $ilDB->quote($a_cname, "text") .
            " AND slot_id = " . $ilDB->quote($a_slot_id, "text") .
            " AND name = " . $ilDB->quote($a_plugin_name, "text");
 
        $set = $ilDB->query($q);
        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec["plugin_id"];
        }
    }

References $ilDB.

Referenced by _getImagePath(), ilObjRepositorySettings\getAllObjTypes(), ilObjectDefinition\getGroupedPluginObjectTypes(), ilModulesTableGUI\getPluginComponents(), getStyleSheetLocation(), and ilObjectDefinition\parsePluginData().

Here is the caller graph for this function:

lookupNameForId()

static ilPlugin::lookupNameForId (   $a_ctype,   $a_cname,   $a_slot_id,   $a_plugin_id  )

static

Lookup name for id.

Reimplemented in ilCachedPlugin.

Definition at line 1150 of file class.ilPlugin.php.

    {
        global $ilDB;
 
        $q = "SELECT name FROM il_plugin " .
            " WHERE component_type = " . $ilDB->quote($a_ctype, "text") .
            " AND component_name = " . $ilDB->quote($a_cname, "text") .
            " AND slot_id = " . $ilDB->quote($a_slot_id, "text") .
            " AND plugin_id = " . $ilDB->quote($a_plugin_id, "text");
 
        $set = $ilDB->query($q);
        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec["name"];
        }
    }

References $ilDB.

Referenced by ilOrgUnitExtensionPlugin\_getIcon(), ilRepositoryObjectPlugin\_getIcon(), ilOrgUnitExtensionPlugin\_getName(), ilRepositoryObjectPlugin\_getName(), ilNavigationHistory\getItems(), ilOrgUnitExtension\getPlugin(), ilOrgUnitExtensionGUI\getPlugin(), ilOrgUnitExtensionListGUI\getPlugin(), ilObjectPlugin\getPlugin(), ilObjectPluginGUI\getPlugin(), ilObjectPluginListGUI\getPlugin(), ilObjectDefinition\isActivePluginType(), ilRepositoryObjectPluginSlot\isTypePlugin(), ilRepositoryObjectPluginSlot\isTypePluginWithLP(), and ilObjectPlugin\loadRepoPlugin().

Here is the caller graph for this function:

lookupStoredData()

static ilPlugin::lookupStoredData (   $a_ctype,   $a_cname,   $a_slot_id,   $a_pname  )

static

Lookup information data in il_plugin.

Parameters

string	$a_ctype
string	$a_cname
string	$a_slot_id
string	$a_pname

Returns

string[]

Definition at line 1084 of file class.ilPlugin.php.

    {
        global $ilDB;
 
        $q = "SELECT * FROM il_plugin WHERE" .
            " component_type = " . $ilDB->quote($a_ctype, "text") . " AND" .
            " component_name = " . $ilDB->quote($a_cname, "text") . " AND" .
            " slot_id = " . $ilDB->quote($a_slot_id, "text") . " AND" .
            " name = " . $ilDB->quote($a_pname, "text");
 
        $set = $ilDB->query($q);
 
        if ($ilDB->numRows($set) == 0) {
            return array();
        }
 
        return $ilDB->fetchAssoc($set);
    }

References $ilDB.

Referenced by ilPluginSlot\getPluginsInformation().

Here is the caller graph for this function:

lookupTxt()

static ilPlugin::lookupTxt (   $a_mod_prefix,   $a_pl_id,   $a_lang_var  )

static

Lookup language text.

Reimplemented in ilCachedPlugin.

Definition at line 512 of file class.ilPlugin.php.

    {
        global $lng;
 
        // this enables default language fallback
        $prefix = $a_mod_prefix . "_" . $a_pl_id;
        return $lng->txt($prefix . "_" . $a_lang_var, $prefix);
    }

References $lng.

needsUpdate()

ilPlugin::needsUpdate

(

)

Check whether update is needed.

Definition at line 757 of file class.ilPlugin.php.

    {
        global $ilPluginAdmin;
 
        return $ilPluginAdmin->needsUpdate(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        );
    }

References getComponentName(), getComponentType(), getPluginName(), and getSlotId().

Referenced by activate().

Here is the call graph for this function:

Here is the caller graph for this function:

readEventListening()

ilPlugin::readEventListening ( )

protected

Read the event listening definitions from the plugin.xml (if file exists)

Definition at line 993 of file class.ilPlugin.php.

    {
        $reader = new ilPluginReader(
            $this->getDirectory() . '/plugin.xml',
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName()
        );
        $reader->clearEvents();
        $reader->startParsing();
    }

References $reader, getComponentName(), getComponentType(), getDirectory(), getPluginName(), and getSlotId().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

setActive()

ilPlugin::setActive (   $a_active )

private

Set Active.

Parameters

boolean

$a_active

Active

Definition at line 183 of file class.ilPlugin.php.

    {
        $this->active = $a_active;
    }

Referenced by __init().

Here is the caller graph for this function:

setDBVersion()

ilPlugin::setDBVersion

(

$a_dbversion

)

Set DB Version.

Parameters

int

$a_dbversion

DB Version

Definition at line 223 of file class.ilPlugin.php.

    {
        $this->dbversion = $a_dbversion;
    }

Referenced by __init(), and writeDBVersion().

Here is the caller graph for this function:

setId()

ilPlugin::setId (   $a_id )

private

Set Id.

Parameters

string

$a_id

Id

Definition at line 83 of file class.ilPlugin.php.

    {
        $this->id = $a_id;
    }

Referenced by __init().

Here is the caller graph for this function:

setIliasMaxVersion()

ilPlugin::setIliasMaxVersion (   $a_iliasmaxversion )

private

Set Required ILIAS max.

release.

Parameters

string

$a_iliasmaxversion

Required ILIAS max. release

Definition at line 163 of file class.ilPlugin.php.

    {
        $this->iliasmaxversion = $a_iliasmaxversion;
    }

Referenced by __init().

Here is the caller graph for this function:

setIliasMinVersion()

ilPlugin::setIliasMinVersion (   $a_iliasminversion )

private

Set Required ILIAS min.

release.

Parameters

string

$a_iliasminversion

Required ILIAS min. release

Definition at line 143 of file class.ilPlugin.php.

    {
        $this->iliasminversion = $a_iliasminversion;
    }

Referenced by __init().

Here is the caller graph for this function:

setLastUpdateVersion()

ilPlugin::setLastUpdateVersion (   $a_lastupdateversion )

private

Set Version of last update.

Parameters

string

$a_lastupdateversion

Version of last update

Definition at line 103 of file class.ilPlugin.php.

    {
        $this->lastupdateversion = $a_lastupdateversion;
    }

Referenced by __init().

Here is the caller graph for this function:

setSlotObject()

ilPlugin::setSlotObject (   $a_slot )

protected

Set Plugin Slot.

Parameters

object

$a_slot

Plugin Slot

Definition at line 203 of file class.ilPlugin.php.

    {
        $this->slot = $a_slot;
    }

Referenced by __init().

Here is the caller graph for this function:

setVersion()

ilPlugin::setVersion (   $a_version )

private

Set Current Version (from plugin.php file).

Parameters

string

$a_version

Current Version (from plugin.php file)

Definition at line 123 of file class.ilPlugin.php.

    {
        $this->version = $a_version;
    }

Referenced by __init().

Here is the caller graph for this function:

slotInit()

ilPlugin::slotInit ( )

abstractprotected

Object initialization done by slot.

Must be overwritten in plugin class of plugin slot.

(and should be made protected)

Reimplemented in ilCloudHookPlugin, ilDclFieldTypePlugin, ilOrgUnitExtensionPlugin, ilOrgUnitTypeHookPlugin, ilStudyProgrammeTypeHookPlugin, ilSurveyQuestionsPlugin, ilTestExportPlugin, ilTestSignaturePlugin, ilQuestionsPlugin, ilAdvancedMDClaimingPlugin, ilShibbolethAuthenticationPlugin, ilAppointmentCustomGridPlugin, ilAppointmentCustomModalPlugin, ilPageComponentPlugin, ilCronHookPlugin, ilEventHookPlugin, ilLDAPPlugin, ilPDFRendererPlugin, ilPersonalDesktopHookPlugin, ilPreviewRendererPlugin, ilRepositoryObjectPlugin, ilUserInterfaceHookPlugin, ilUDFClaimingPlugin, ilSoapHookPlugin, and ilComplexGatewayPlugin.

Referenced by __init().

Here is the caller graph for this function:

txt()

ilPlugin::txt

(

$a_var

)

Get Language Variable (prefix will be prepended automatically)

Definition at line 502 of file class.ilPlugin.php.

    {
        global $lng;
        $this->loadLanguageModule();
        return $lng->txt($this->getPrefix() . "_" . $a_var, $this->getPrefix());
    }

References $lng, getPrefix(), and loadLanguageModule().

Here is the call graph for this function:

uninstall()

ilPlugin::uninstall ( )

final

Definition at line 893 of file class.ilPlugin.php.

    {
        global $ilDB;
    
        if ($this->beforeUninstall()) {
            // remove all language entries (see ilObjLanguage)
            // see updateLanguages
            $prefix = $this->getPrefix();
            if ($prefix) {
                $ilDB->manipulate("DELETE FROM lng_data" .
                    " WHERE module = " . $ilDB->quote($prefix, "text"));
                $ilDB->manipulate("DELETE FROM lng_modules" .
                    " WHERE module = " . $ilDB->quote($prefix, "text"));
            }
 
            $this->clearEventListening();
 
            // db version is kept in il_plugin - will be deleted, too
            
            $q = "DELETE FROM il_plugin" .
                " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
                " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
                " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
                " AND name = " . $ilDB->quote($this->getPluginName(), "text");
            $ilDB->manipulate($q);
 
            $this->afterUninstall();
            
            ilCachedComponentData::flush();
            return true;
        }
 
        return false;
    }

References $ilDB, afterUninstall(), beforeUninstall(), clearEventListening(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getPluginName(), getPrefix(), and getSlotId().

Here is the call graph for this function:

update()

ilPlugin::update

(

)

Update plugin.

Definition at line 936 of file class.ilPlugin.php.

    {
        global $ilDB, $ilCtrl;
 
        ilCachedComponentData::flush();
 
        $result = $this->beforeUpdate();
        if ($result === false) {
            return false;
        }
 
        // DB update
        if ($result === true) {
            $result = $this->updateDatabase();
        }
 
        // Load language files
        $this->updateLanguages();
 
        // load control structure
        include_once("./setup/classes/class.ilCtrlStructureReader.php");
        $structure_reader = new ilCtrlStructureReader();
        $structure_reader->readStructure(
            true,
            "./" . $this->getDirectory(),
            $this->getPrefix(),
            $this->getDirectory()
        );
        //              $ilCtrl->storeCommonStructures();
 
        // add config gui to the ctrl calls
        $ilCtrl->insertCtrlCalls(
            "ilobjcomponentsettingsgui",
            ilPlugin::getConfigureClassName($this->getPluginName()),
            $this->getPrefix()
        );
 
        $this->readEventListening();
 
        // set last update version to current version
        if ($result === true) {
            $q = "UPDATE il_plugin SET last_update_version = " . $ilDB->quote($this->getVersion(), "text") .
                " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
                " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
                " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
                " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
            $ilDB->manipulate($q);
            $this->afterUpdate();
        }
 
        return $result;
    }

References $ilCtrl, $ilDB, $result, afterUpdate(), beforeUpdate(), ilCachedComponentData\flush(), getComponentName(), getComponentType(), getConfigureClassName(), getDirectory(), getPluginName(), getPrefix(), getSlotId(), getVersion(), readEventListening(), updateDatabase(), and updateLanguages().

Referenced by activate(), and ilObjComponentSettingsGUI\update().

Here is the call graph for this function:

Here is the caller graph for this function:

updateDatabase()

ilPlugin::updateDatabase

(

)

Update database.

Reimplemented in ilCachedPlugin.

Definition at line 451 of file class.ilPlugin.php.

    {
        global $ilDB, $lng;
 
        ilCachedComponentData::flush();
 
        include_once("./Services/Component/classes/class.ilPluginDBUpdate.php");
        $dbupdate = new ilPluginDBUpdate(
            $this->getComponentType(),
            $this->getComponentName(),
            $this->getSlotId(),
            $this->getPluginName(),
            $ilDB,
            true,
            $this->getTablePrefix()
        );
 
        //$dbupdate->getDBVersionStatus();
        //$dbupdate->getCurrentVersion();
 
        $result = $dbupdate->applyUpdate();
        $message = '';
        if ($dbupdate->updateMsg == "no_changes") {
            $message = $lng->txt("no_changes") . ". " . $lng->txt("database_is_uptodate");
        } else {
            foreach ($dbupdate->updateMsg as $row) {
                $message .= $lng->txt($row["msg"]) . ": " . $row["nr"] . "<br/>";
            }
        }
 
        $this->message.= $message;
 
        return $result;
    }

References $ilDB, $lng, $message, $result, $row, ilCachedComponentData\flush(), getComponentName(), getComponentType(), getPluginName(), getSlotId(), and getTablePrefix().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

updateLanguages()

ilPlugin::updateLanguages

(

$a_lang_keys = null

)

Definition at line 394 of file class.ilPlugin.php.

    {
        ilGlobalCache::flushAll();
        include_once("./Services/Language/classes/class.ilObjLanguage.php");
 
        // get the keys of all installed languages if keys are not provided
        if (!isset($a_lang_keys)) {
            $a_lang_keys = array();
            foreach (ilObjLanguage::getInstalledLanguages() as $langObj) {
                if ($langObj->isInstalled()) {
                    $a_lang_keys[] = $langObj->getKey();
                }
            }
        }
 
        $langs = $this->getAvailableLangFiles($this->getLanguageDirectory());
 
        $prefix = $this->getPrefix();
 
        foreach ($langs as $lang) {
            // check if the language should be updated, otherwise skip it
            if (!in_array($lang['key'], $a_lang_keys)) {
                continue;
            }
 
            $txt = file($this->getLanguageDirectory() . "/" . $lang["file"]);
            $lang_array = array();
 
            // get locally changed variables of the module (these should be kept)
            $local_changes = ilObjLanguage::_getLocalChangesByModule($lang['key'], $prefix);
 
            // get language data
            if (is_array($txt)) {
                foreach ($txt as $row) {
                    if ($row[0] != "#" && strpos($row, "#:#") > 0) {
                        $a = explode("#:#", trim($row));
                        $identifier = $prefix . "_" . trim($a[0]);
                        $value = trim($a[1]);
 
                        if (isset($local_changes[$identifier])) {
                            $lang_array[$identifier] = $local_changes[$identifier];
                        } else {
                            $lang_array[$identifier] = $value;
                            ilObjLanguage::replaceLangEntry($prefix, $identifier, $lang["key"], $value);
                        }
                        //echo "<br>-$prefix-".$prefix."_".trim($a[0])."-".$lang["key"]."-";
                    }
                }
            }
 
            ilObjLanguage::replaceLangModule($lang["key"], $prefix, $lang_array);
        }
    }

References $lang, $row, $txt, getAvailableLangFiles(), ilObjLanguage\getInstalledLanguages(), getLanguageDirectory(), getPrefix(), and ilObjLanguage\replaceLangEntry().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

writeDBVersion()

ilPlugin::writeDBVersion

(

$a_dbversion

)

Write DB version to database.

Parameters

int

$a_dbversion

DB Version

Definition at line 243 of file class.ilPlugin.php.

    {
        global $ilDB;
 
        $this->setDBVersion($a_dbversion);
 
        $q = "UPDATE il_plugin SET db_version = " . $ilDB->quote((int) $this->getDBVersion(), "integer") .
            " WHERE component_type = " . $ilDB->quote($this->getComponentType(), "text") .
            " AND component_name = " . $ilDB->quote($this->getComponentName(), "text") .
            " AND slot_id = " . $ilDB->quote($this->getSlotId(), "text") .
            " AND name = " . $ilDB->quote($this->getPluginName(), "text");
 
        $ilDB->manipulate($q);
    }

References $ilDB, getComponentName(), getComponentType(), getDBVersion(), getPluginName(), getSlotId(), and setDBVersion().

Here is the call graph for this function:

Field Documentation

$id

ilPlugin::$id = ''

protected

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

Referenced by getId(), ilCloudHookPlugin\getPluginTablePrefix(), and ilDclFieldTypePlugin\getPluginTablePrefix().

$lang_initialised

ilPlugin::$lang_initialised = false

protected

Definition at line 22 of file class.ilPlugin.php.

---

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

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