Abstract parent class for all repository object plugin classes. More...

Inheritance diagram for ilRepositoryObjectPlugin:

Collaboration diagram for ilRepositoryObjectPlugin:

Public Member Functions
	__construct ()
	Constructor. More...

	getComponentType ()
	Get Component Type. More...

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	getParentTypes ()

	allowCopy ()
	decides if this repository plugin can be copied More...

Public Member Functions inherited from ilPlugin
	__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	_getIcon ($a_type, $a_size)
	Get Icon. More...

static	_getName ($a_id)
	Get class name. More...

Static Public Member Functions inherited from ilPlugin
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
	slotInit ()
	Object initialization done by slot. More...

	beforeActivation ()
	Before activation processing. More...

	beforeUninstallCustom ()

	uninstallCustom ()

	beforeUninstall ()

Protected Member Functions inherited from ilPlugin
	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
	$lng

	$db

Protected Attributes inherited from ilPlugin
	$lang_initialised = false

	$id = ''

Detailed Description

Abstract parent class for all repository object plugin classes.

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

Version: $Id$

Definition at line 13 of file class.ilRepositoryObjectPlugin.php.

Constructor & Destructor Documentation

◆ __construct()

ilRepositoryObjectPlugin::__construct ( )

Constructor.

Definition at line 29 of file class.ilRepositoryObjectPlugin.php.

References $DIC.

     {
         global $DIC;
         parent::__construct();
 
         $this->db = $DIC->database();
     }

Member Function Documentation

◆ _getIcon()

static ilRepositoryObjectPlugin::_getIcon	(	$a_type,
		$a_size
	)

static

Get Icon.

Definition at line 88 of file class.ilRepositoryObjectPlugin.php.

References $a_type, ilPlugin\_getImagePath(), IL_COMP_SERVICE, and ilPlugin\lookupNameForId().

     {
         return ilPlugin::_getImagePath(
             IL_COMP_SERVICE,
             "Repository",
             "robj",
             ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj", $a_type),
             "icon_" . $a_type . ".svg"
         );
     }

Here is the call graph for this function:

◆ _getName()

static ilRepositoryObjectPlugin::_getName ( $a_id )

static

Get class name.

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

References $name, IL_COMP_SERVICE, and ilPlugin\lookupNameForId().

     {
         $name = ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj", $a_id);
         if ($name != "") {
             return $name;
         }
     }

Here is the call graph for this function:

◆ allowCopy()

ilRepositoryObjectPlugin::allowCopy ( )

decides if this repository plugin can be copied

Returns: bool

Definition at line 255 of file class.ilRepositoryObjectPlugin.php.

Referenced by beforeActivation().

     {
         return false;
     }

Here is the caller graph for this function:

◆ beforeActivation()

ilRepositoryObjectPlugin::beforeActivation ( )

protected

Before activation processing.

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

References $db, $ilDB, $type, ilRbacReview\_getOperationIdByName(), allowCopy(), array, ilPlugin\getId(), getParentTypes(), ilPlugin\getPluginName(), and ilUtil\now().

     {
         $ilDB = $this->db;
         
         // before activating, we ensure, that the type exists in the ILIAS
         // object database and that all permissions exist
         $type = $this->getId();
         
         if (substr($type, 0, 1) != "x") {
             throw new ilPluginException("Object plugin type must start with an x. Current type is " . $type . ".");
         }
         
         // check whether type exists in object data, if not, create the type
         $set = $ilDB->query(
             "SELECT * FROM object_data " .
             " WHERE type = " . $ilDB->quote("typ", "text") .
             " AND title = " . $ilDB->quote($type, "text")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             $t_id = $rec["obj_id"];
         } else {
             $t_id = $ilDB->nextId("object_data");
             $ilDB->manipulate("INSERT INTO object_data " .
                 "(obj_id, type, title, description, owner, create_date, last_update) VALUES (" .
                 $ilDB->quote($t_id, "integer") . "," .
                 $ilDB->quote("typ", "text") . "," .
                 $ilDB->quote($type, "text") . "," .
                 $ilDB->quote("Plugin " . $this->getPluginName(), "text") . "," .
                 $ilDB->quote(-1, "integer") . "," .
                 $ilDB->quote(ilUtil::now(), "timestamp") . "," .
                 $ilDB->quote(ilUtil::now(), "timestamp") .
                 ")");
         }
 
         // add rbac operations
         // 1: edit_permissions, 2: visible, 3: read, 4:write, 6:delete
         $ops = array(1, 2, 3, 4, 6);
         if ($this->allowCopy()) {
             $ops[] = ilRbacReview::_getOperationIdByName("copy");
         }
         foreach ($ops as $op) {
             // check whether type exists in object data, if not, create the type
             $set = $ilDB->query(
                 "SELECT * FROM rbac_ta " .
                 " WHERE typ_id = " . $ilDB->quote($t_id, "integer") .
                 " AND ops_id = " . $ilDB->quote($op, "integer")
             );
             if (!$ilDB->fetchAssoc($set)) {
                 $ilDB->manipulate("INSERT INTO rbac_ta " .
                     "(typ_id, ops_id) VALUES (" .
                     $ilDB->quote($t_id, "integer") . "," .
                     $ilDB->quote($op, "integer") .
                     ")");
             }
         }
         
         // now add creation permission, if not existing
         $set = $ilDB->query(
             "SELECT * FROM rbac_operations " .
             " WHERE class = " . $ilDB->quote("create", "text") .
             " AND operation = " . $ilDB->quote("create_" . $type, "text")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             $create_ops_id = $rec["ops_id"];
         } else {
             $create_ops_id = $ilDB->nextId("rbac_operations");
             $ilDB->manipulate("INSERT INTO rbac_operations " .
                 "(ops_id, operation, description, class) VALUES (" .
                 $ilDB->quote($create_ops_id, "integer") . "," .
                 $ilDB->quote("create_" . $type, "text") . "," .
                 $ilDB->quote("create " . $type, "text") . "," .
                 $ilDB->quote("create", "text") .
                 ")");
         }
         
         // assign creation operation to root, cat, crs, grp and fold
         $par_types = $this->getParentTypes();
         foreach ($par_types as $par_type) {
             $set = $ilDB->query(
                 "SELECT obj_id FROM object_data " .
                 " WHERE type = " . $ilDB->quote("typ", "text") .
                 " AND title = " . $ilDB->quote($par_type, "text")
             );
             if ($rec = $ilDB->fetchAssoc($set)) {
                 if ($rec["obj_id"] > 0) {
                     $set = $ilDB->query(
                         "SELECT * FROM rbac_ta " .
                         " WHERE typ_id = " . $ilDB->quote($rec["obj_id"], "integer") .
                         " AND ops_id = " . $ilDB->quote($create_ops_id, "integer")
                     );
                     if (!$ilDB->fetchAssoc($set)) {
                         $ilDB->manipulate("INSERT INTO rbac_ta " .
                             "(typ_id, ops_id) VALUES (" .
                             $ilDB->quote($rec["obj_id"], "integer") . "," .
                             $ilDB->quote($create_ops_id, "integer") .
                             ")");
                     }
                 }
             }
         }
         
         return true;
     }

Here is the call graph for this function:

◆ beforeUninstall()

ilRepositoryObjectPlugin::beforeUninstall ( )

finalprotected

Definition at line 226 of file class.ilRepositoryObjectPlugin.php.

References beforeUninstallCustom(), ilPlugin\getId(), and uninstallCustom().

     {
         if ($this->beforeUninstallCustom()) {
             include_once "Services/Repository/classes/class.ilRepUtil.php";
             $rep_util = new ilRepUtil();
             $rep_util->deleteObjectType($this->getId());
             
             // custom database tables may be needed by plugin repository object
             $this->uninstallCustom();
 
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ beforeUninstallCustom()

ilRepositoryObjectPlugin::beforeUninstallCustom ( )

protected

Definition at line 217 of file class.ilRepositoryObjectPlugin.php.

References uninstallCustom().

Referenced by beforeUninstall().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponentName()

ilRepositoryObjectPlugin::getComponentName ( )

Get Component Name.

Returns: string Component Name

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

     {
         return "Repository";
     }

◆ getComponentType()

ilRepositoryObjectPlugin::getComponentType ( )

Get Component Type.

Returns: string Component Type

Definition at line 42 of file class.ilRepositoryObjectPlugin.php.

References IL_COMP_SERVICE.

     {
         return IL_COMP_SERVICE;
     }

◆ getParentTypes()

ilRepositoryObjectPlugin::getParentTypes ( )

Returns: string[]

Definition at line 244 of file class.ilRepositoryObjectPlugin.php.

References array.

Referenced by beforeActivation().

     {
         $par_types = array("root", "cat", "crs", "grp", "fold");
         return $par_types;
     }

Here is the caller graph for this function:

◆ getSlot()

ilRepositoryObjectPlugin::getSlot ( )

Get Slot Name.

Returns: string Slot Name

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

     {
         return "RepositoryObject";
     }

◆ getSlotId()

ilRepositoryObjectPlugin::getSlotId ( )

Get Slot ID.

Returns: string Slot Id

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

     {
         return "robj";
     }

◆ slotInit()

ilRepositoryObjectPlugin::slotInit ( )

protected

Object initialization done by slot.

Definition at line 80 of file class.ilRepositoryObjectPlugin.php.

     {
         // nothing to do here
     }

◆ uninstallCustom()

ilRepositoryObjectPlugin::uninstallCustom ( )

abstractprotected

Referenced by beforeUninstall(), and beforeUninstallCustom().

Here is the caller graph for this function:

Field Documentation

◆ $db

ilRepositoryObjectPlugin::$db

protected

Definition at line 23 of file class.ilRepositoryObjectPlugin.php.

Referenced by beforeActivation().

◆ $lng

ilRepositoryObjectPlugin::$lng

protected

Definition at line 18 of file class.ilRepositoryObjectPlugin.php.

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

Services/Repository/classes/class.ilRepositoryObjectPlugin.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getIcon()

◆ _getName()

◆ allowCopy()

◆ beforeActivation()

◆ beforeUninstall()

◆ beforeUninstallCustom()

◆ getComponentName()

◆ getComponentType()

◆ getParentTypes()

◆ getSlot()

◆ getSlotId()

◆ slotInit()

◆ uninstallCustom()

Field Documentation

◆ $db

◆ $lng