This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilRepositoryObjectPlugin:

Collaboration diagram for ilRepositoryObjectPlugin:

Public Member Functions
	getParentTypes ()

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

	useOrguPermissions ()
	Decide if this repository plugin uses OrgUnit Permissions. More...

	getPrefix ()

Public Member Functions inherited from ilPlugin
	getMessage ()

	__construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id)

	getPluginName ()

	getId ()

	getVersion ()
	Only very little classes seem to care about this: More...

	getDirectory ()
	Only very little classes seem to care about this: More...

	isActive ()
	Only very little classes seem to care about this: More...

	needsUpdate ()

	install ()

	uninstall ()

	activate ()
	This will update (if required) and activate the plugin. More...

	deactivate ()

	update ()

	loadLanguageModule ()
	Load language module for plugin. More...

	txt (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...

	getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	getStyleSheetLocation (string $a_css_file)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	getGlobalScreenProviderCollection ()

	exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic)
	This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More...

	exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic)
	This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More...

Static Public Member Functions
static	_getImagePath (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname, string $a_img)
	Only very little classes seem to care about this: More...

static	_getIcon (string $a_type)

static	_getName (string $a_id)

Protected Member Functions
	beforeActivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	beforeUninstallCustom ()

	uninstallCustom ()

	beforeUninstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

Protected Member Functions inherited from ilPlugin
	init ()
	Object initialization. More...

	getPluginInfo ()

	getComponentInfo ()

	getPluginSlotInfo ()

	afterInstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...

	beforeUninstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	afterUninstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	beforeActivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterActivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterDeactivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	updateDatabase ()

	beforeUpdate ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More...

	afterUpdate ()

	getLanguageHandler ()

	buildLanguageHandler ()

Protected Attributes
ilLanguage	$lng

Protected Attributes inherited from ilPlugin
ilDBInterface	$db

ilComponentRepositoryWrite	$component_repository

string	$id

ilPluginLanguage	$language_handler = null

bool	$lang_initialised = false

ProviderCollection	$provider_collection

string	$message = ''

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Abstract parent class for all repository object plugin classes.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ _getIcon()

static ilRepositoryObjectPlugin::_getIcon ( string $a_type )

static

Reimplemented in ilOrgUnitExtensionPlugin.

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

                                                   : string
    {
        global $DIC;
        $component_repository = $DIC["component.repository"];
        return self::_getImagePath(
            ilComponentInfo::TYPES[0],
            "Repository",
            "robj",
            $component_repository->getPluginById($a_type)->getName(),
            "icon_" . $a_type . ".svg"
        );
    }

References ilPlugin\$component_repository, $DIC, _getImagePath(), ilComponentRepository\getPluginById(), and ilComponentInfo\TYPES.

Here is the call graph for this function:

◆ _getImagePath()

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

static

Only very little classes seem to care about this:

Services/Repository/classes/class.ilRepositoryObjectPlugin.php
Modules/OrgUnit/classes/Extension/class.ilOrgUnitExtensionPlugin.php

Parameters

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

Returns: string

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

                                                                                                                             : string
    {
        global $DIC;
 
        $img = ilUtil::getImagePath($a_img);
        if (is_int(strpos($img, "Customizing"))) {
            return $img;
        }
 
        $component_repository = $DIC["component.repository"];
 
        $plugin = $component_repository->getPluginByName($a_pname);
        $component = $component_repository->getComponentByTypeAndName($a_ctype, $a_cname);
 
        $d2 = $component->getId() . "_" . $a_slot_id . "_" . $plugin->getId();
 
        $img = ilUtil::getImagePath($d2 . "/" . $a_img);
        if (is_int(strpos($img, "Customizing"))) {
            return $img;
        }
 
        $d = $plugin->getPath();
        return $d . "/templates/images/" . $a_img;
    }

References ilPlugin\$component_repository, Vendor\Package\$d, $DIC, XapiProxy\$plugin, ilComponentRepository\getComponentByTypeAndName(), ilUtil\getImagePath(), and ilComponentRepository\getPluginByName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getName()

static ilRepositoryObjectPlugin::_getName ( string $a_id )

static

Reimplemented in ilOrgUnitExtensionPlugin.

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

                                                 : string
    {
        global $DIC;
        $component_repository = $DIC["component.repository"];
        if (!$component_repository->hasPluginId($a_id)) {
            return "";
        }
        return $component_repository->getPluginById($a_id)->getName();
    }

References ilPlugin\$component_repository, $DIC, ilComponentRepository\getPluginById(), and ilComponentRepository\hasPluginId().

Here is the call graph for this function:

◆ allowCopy()

ilRepositoryObjectPlugin::allowCopy ( )

decides if this repository plugin can be copied

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

                               : bool
    {
        return false;
    }

Referenced by beforeActivation().

Here is the caller graph for this function:

◆ beforeActivation()

ilRepositoryObjectPlugin::beforeActivation ( )

protected

@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead.

Reimplemented from ilPlugin.

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

                                         : bool
    {
        $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 (strpos($type, "x") !== 0) {
            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 = [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)) && $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;
    }

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

Here is the call graph for this function:

◆ beforeUninstall()

ilRepositoryObjectPlugin::beforeUninstall ( )

finalprotected

@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead.

Reimplemented from ilPlugin.

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

                                              : bool
    {
        if ($this->beforeUninstallCustom()) {
            $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;
    }

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

Here is the call graph for this function:

◆ beforeUninstallCustom()

ilRepositoryObjectPlugin::beforeUninstallCustom ( )

protected

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

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

Referenced by beforeUninstall().

Here is the caller graph for this function:

◆ getParentTypes()

ilRepositoryObjectPlugin::getParentTypes ( )

Returns: string[]

Reimplemented in ilOrgUnitExtensionPlugin.

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

                                    : array
    {
        $par_types = ["root", "cat", "crs", "grp", "fold"];
        return $par_types;
    }

Referenced by beforeActivation().

Here is the caller graph for this function:

◆ getPrefix()

ilRepositoryObjectPlugin::getPrefix ( )

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

                               : string
    {
        $lh = $this->getLanguageHandler();
        return $lh->getPrefix();
    }

References ilPlugin\getLanguageHandler().

Here is the call graph for this function:

◆ uninstallCustom()

ilRepositoryObjectPlugin::uninstallCustom ( )

abstractprotected

Referenced by beforeUninstall().

Here is the caller graph for this function:

◆ useOrguPermissions()

ilRepositoryObjectPlugin::useOrguPermissions ( )

Decide if this repository plugin uses OrgUnit Permissions.

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

                                        : bool
    {
        return false;
    }

Field Documentation

◆ $lng

ilLanguage ilRepositoryObjectPlugin::$lng

protected

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

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

components/ILIAS/Repository/PluginSlot/class.ilRepositoryObjectPlugin.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _getIcon()

◆ _getImagePath()

◆ _getName()

◆ allowCopy()

◆ beforeActivation()

◆ beforeUninstall()

◆ beforeUninstallCustom()

◆ getParentTypes()

◆ getPrefix()

◆ uninstallCustom()

◆ useOrguPermissions()

Field Documentation

◆ $lng