Abstract parent class for all advanced md claiming plugin classes. More...

Inheritance diagram for ilAdvancedMDClaimingPlugin:

Collaboration diagram for ilAdvancedMDClaimingPlugin:

Public Member Functions
	checkPermission (int $a_user_id, int $a_context_type, int $a_context_id, int $a_action_id, int $a_action_sub_id)

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	hasDBRecord (int $a_record_id)

static	createDBRecord (string $a_title, string $a_description, bool $a_active, array $a_obj_types)

static	updateDBRecord (int $a_record_id, string $a_title, string $a_description, bool $a_active, array $a_obj_types)
	Update record db entry. More...

static	deleteDBRecord (int $a_record_id)

static	hasDBField (int $a_field_id)

static	createDBField (int $a_record_id, int $a_type, string $a_title, ?string $a_description=null, bool $a_searchable=false, ?array $a_definition=null)

static	updateDBField (int $a_field_id, string $a_title, ?string $a_description=null, bool $a_searchable=false, ?array $a_definition=null)

static	deleteDBField (int $a_field_id)

static	setDBSubstitution (string $a_obj_type, bool $a_show_description, bool $a_show_field_names)

static	hasDBFieldSubstitution (string $a_obj_type, int $a_field_id)

static	setDBFieldSubstitution (string $a_obj_type, int $a_field_id, bool $a_bold=false, bool $a_newline=false)

static	removeDBFieldSubstitution (string $a_obj_type, int $a_field_id)

Static Protected Member Functions
static	isValidObjType (string $a_obj_type, bool $a_is_substitution=false)
	Validate object type. More...

static	saveRecordObjTypes (int $a_record_id, array $a_obj_types)
	Save object type assignments for record. More...

static	getDBFieldLastPosition (int $a_record_id)

static	getDBSubstitution (string $a_obj_type, bool $a_include_field_data=false)

Additional Inherited Members
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 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

Abstract parent class for all advanced md claiming plugin classes.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

◆ checkPermission()

ilAdvancedMDClaimingPlugin::checkPermission	(	int	$a_user_id,
		int	$a_context_type,
		int	$a_context_id,
		int	$a_action_id,
		int	$a_action_sub_id
	)

abstract

◆ createDBField()

static ilAdvancedMDClaimingPlugin::createDBField	(	int	$a_record_id,
		int	$a_type,
		string	$a_title,
		?string	$a_description = `null`,
		bool	$a_searchable = `false`,
		?array	$a_definition = `null`
	)

static

Definition at line 211 of file class.ilAdvancedMDClaimingPlugin.php.

     : ?int {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (!self::hasDBRecord($a_record_id)) {
            return null;
        }
 
        $field_id = $ilDB->nextId("adv_mdf_definition");
 
        // validating type
        if (!ilAdvancedMDFieldDefinition::isValidType($a_type)) {
            return null;
        }
 
        $options_in_different_table = $a_definition &&
            ($a_type === ilAdvancedMDFieldDefinition::TYPE_SELECT ||
            $a_type === ilAdvancedMDFieldDefinition::TYPE_SELECT_MULTI);
 
        $pos = self::getDBFieldLastPosition($a_record_id) + 1;
 
        $fields = array(
            "record_id" => array("integer", $a_record_id),
            "field_id" => array("integer", $field_id),
            "import_id" => array("text", "il_" . IL_INST_ID . "_adv_md_field_" . $field_id),
            "field_type" => array("integer", $a_type),
            "position" => array("integer", $pos),
            "title" => array("text", trim($a_title)),
            "description" => array("text", trim((string) $a_description)),
            "searchable" => array("integer", (int) $a_searchable)
        );
        if ($a_definition && !$options_in_different_table) {
            $fields["field_values"] = array("text", serialize($a_definition));
        }
        $ilDB->insert("adv_mdf_definition", $fields);
 
        if ($options_in_different_table) {
            $ilDB->manipulate(
                'DELETE FROM adv_mdf_enum WHERE field_id = ' .
                $ilDB->quote($field_id, ilDBConstants::T_INTEGER)
            );
 
            $default_language = '';
            $res = $ilDB->query(
                'SELECT lang_default FROM adv_md_record WHERE record_id = ' .
                $ilDB->quote($a_record_id, 'integer')
            );
            if ($row = $res->fetchAssoc()) {
                $default_language = (string) $row['lang_default'];
            }
 
            $idx = 0;
            foreach ($a_definition as $option) {
                if (!is_string($option)) {
                    continue;
                }
                $ilDB->insert(
                    'adv_mdf_enum',
                    [
                        'field_id' => [ilDBConstants::T_INTEGER, $field_id],
                        'lang_code' => [ilDBConstants::T_TEXT, $default_language],
                        'idx' => [ilDBConstants::T_INTEGER, $idx],
                        'value' => [ilDBConstants::T_TEXT, $option],
                        'position' => [ilDBConstants::T_INTEGER, $idx]
                    ]
                );
                $idx++;
            }
        }
 
        return $field_id;
    }

◆ createDBRecord()

static ilAdvancedMDClaimingPlugin::createDBRecord	(	string	$a_title,
		string	$a_description,
		bool	$a_active,
		array	$a_obj_types
	)

static

Parameters

string	$a_title
string	$a_description
bool	$a_active
string[]	$a_obj_types

Returns: int

Definition at line 53 of file class.ilAdvancedMDClaimingPlugin.php.

     : int {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $record_id = $ilDB->nextId("adv_md_record");
 
        $fields = array(
            "record_id" => array("integer", $record_id),
            "import_id" => array("text", 'il_' . IL_INST_ID . '_adv_md_record_' . $record_id),
            "title" => array("text", trim($a_title)),
            "description" => array("text", trim($a_description)),
            "active" => array("integer", (int) $a_active)
        );
        $ilDB->insert("adv_md_record", $fields);
        self::saveRecordObjTypes($record_id, $a_obj_types);
        return $record_id;
    }

◆ deleteDBField()

static ilAdvancedMDClaimingPlugin::deleteDBField ( int $a_field_id )

static

Definition at line 324 of file class.ilAdvancedMDClaimingPlugin.php.

                                                         : bool
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if (self::hasDBField($a_field_id)) {
            $ilDB->manipulate("DELETE FROM adv_mdf_definition" .
                " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
            return true;
        }
 
        return false;
    }

References $DIC, and $ilDB.

◆ deleteDBRecord()

static ilAdvancedMDClaimingPlugin::deleteDBRecord ( int $a_record_id )

static

Definition at line 166 of file class.ilAdvancedMDClaimingPlugin.php.

                                                           : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (self::hasDBRecord($a_record_id)) {
            $ilDB->manipulate("DELETE FROM adv_md_record" .
                " WHERE record_id = " . $ilDB->quote($a_record_id, "integer"));
            return true;
        }
 
        return false;
    }

References $DIC, and $ilDB.

◆ getDBFieldLastPosition()

static ilAdvancedMDClaimingPlugin::getDBFieldLastPosition ( int $a_record_id )

staticprotected

See also: ilAdvancedMDFieldDefinition::getLastPosition()

Definition at line 194 of file class.ilAdvancedMDClaimingPlugin.php.

                                                                      : int
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $sql = "SELECT max(position) pos" .
            " FROM adv_mdf_definition" .
            " WHERE record_id = " . $ilDB->quote($a_record_id, "integer");
        $set = $ilDB->query($sql);
        if ($ilDB->numRows($set)) {
            $pos = $ilDB->fetchAssoc($set);
            return (int) $pos["pos"];
        }
        return 0;
    }

References $DIC, and $ilDB.

◆ getDBSubstitution()

static ilAdvancedMDClaimingPlugin::getDBSubstitution	(	string	$a_obj_type,
		bool	$a_include_field_data = `false`
	)

staticprotected

Definition at line 339 of file class.ilAdvancedMDClaimingPlugin.php.

                                                                                                       : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT * FROM adv_md_substitutions" .
            " WHERE obj_type = " . $ilDB->quote($a_obj_type, "text"));
        if ($ilDB->numRows($set)) {
            $res = $ilDB->fetchAssoc($set);
            $res["hide_description"] = array("integer", (bool) $res["hide_description"]);
            $res["hide_field_names"] = array("integer", (bool) $res["hide_field_names"]);
 
            if ($a_include_field_data) {
                $res["substitution"] = array("text", (array) unserialize($res["substitution"]));
            } else {
                unset($res["substitution"]);
            }
            unset($res["obj_type"]);
 
            return $res;
        }
        return [];
    }

References $DIC, $ilDB, and $res.

◆ hasDBField()

static ilAdvancedMDClaimingPlugin::hasDBField ( int $a_field_id )

static

Definition at line 181 of file class.ilAdvancedMDClaimingPlugin.php.

                                                      : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT field_id FROM adv_mdf_definition" .
            " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
        return (bool) $ilDB->numRows($set);
    }

References $DIC, and $ilDB.

◆ hasDBFieldSubstitution()

static ilAdvancedMDClaimingPlugin::hasDBFieldSubstitution	(	string	$a_obj_type,
		int	$a_field_id
	)

static

Definition at line 400 of file class.ilAdvancedMDClaimingPlugin.php.

                                                                                      : bool
    {
        if (self::isValidObjType($a_obj_type, true)) {
            $fields = self::getDBSubstitution($a_obj_type, true);
            $fields = $fields["substitution"][1];
            foreach ($fields as $field) {
                if ($field["field_id"] == $a_field_id) {
                    return true;
                }
            }
        }
        return false;
    }

◆ hasDBRecord()

static ilAdvancedMDClaimingPlugin::hasDBRecord ( int $a_record_id )

static

Definition at line 36 of file class.ilAdvancedMDClaimingPlugin.php.

                                                        : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT record_id FROM adv_md_record" .
            " WHERE record_id = " . $ilDB->quote($a_record_id, "integer"));
        return (bool) $ilDB->numRows($set);
    }

References $DIC, and $ilDB.

◆ isValidObjType()

static ilAdvancedMDClaimingPlugin::isValidObjType	(	string	$a_obj_type,
		bool	$a_is_substitution = `false`
	)

staticprotected

Validate object type.

Todo:: support ecs type

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

                                                                                                 : bool
    {
        // ecs not supported yet
        $valid = ["crs", "cat", "book", "wiki", "glo", "orgu", "prg", 'grp', 'iass'];
 
        if (!$a_is_substitution) {
            $valid[] = "orgu";
            $valid[] = "prg";
        }
 
        return in_array($a_obj_type, $valid);
    }

References $valid.

◆ removeDBFieldSubstitution()

static ilAdvancedMDClaimingPlugin::removeDBFieldSubstitution	(	string	$a_obj_type,
		int	$a_field_id
	)

static

Definition at line 462 of file class.ilAdvancedMDClaimingPlugin.php.

                                                                                         : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (self::isValidObjType($a_obj_type, true)) {
            $fields = self::getDBSubstitution($a_obj_type, true);
            if (!$fields) {
                return true;
            } else {
                $fields = $fields["substitution"][1];
            }
 
            $found = false;
            foreach ($fields as $idx => $field) {
                if ($field["field_id"] == $a_field_id) {
                    unset($fields[$idx]);
                    $found = true;
                    break;
                }
            }
            if ($found) {
                $fields = array("substitution" => array("text", serialize($fields)));
                $ilDB->update(
                    "adv_md_substitutions",
                    $fields,
                    array("obj_type" => array("text", $a_obj_type))
                );
            }
            return true;
        }
        return false;
    }

References $DIC, and $ilDB.

◆ saveRecordObjTypes()

static ilAdvancedMDClaimingPlugin::saveRecordObjTypes	(	int	$a_record_id,
		array	$a_obj_types
	)

staticprotected

Save object type assignments for record.

Parameters

int	$a_record_id
string[]	$a_obj_types

Definition at line 99 of file class.ilAdvancedMDClaimingPlugin.php.

                                                                                      : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        foreach ($a_obj_types as $type) {
            if (!is_array($type)) {
                $type = strtolower(trim($type));
                $subtype = "-";
            } else {
                $subtype = strtolower(trim($type[1]));
                $type = strtolower(trim($type[0]));
            }
 
            if (self::isValidObjType($type)) {
                $fields = array(
                    "record_id" => array("integer", $a_record_id),
                    "obj_type" => array("text", $type),
                    "sub_type" => array("text", $subtype)
                );
                $ilDB->insert("adv_md_record_objs", $fields);
            }
        }
    }

References $DIC, and $ilDB.

◆ setDBFieldSubstitution()

static ilAdvancedMDClaimingPlugin::setDBFieldSubstitution	(	string	$a_obj_type,
		int	$a_field_id,
		bool	$a_bold = `false`,
		bool	$a_newline = `false`
	)

static

Definition at line 414 of file class.ilAdvancedMDClaimingPlugin.php.

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (self::isValidObjType($a_obj_type, true)) {
            $fields = self::getDBSubstitution($a_obj_type, true);
            if (!$fields) {
                self::setDBSubstitution($a_obj_type, true, true);
                $fields = array();
            } else {
                $fields = $fields["substitution"][1];
            }
 
            $found = false;
            foreach ($fields as $idx => $field) {
                if ($field["field_id"] == $a_field_id) {
                    $fields[$idx]["bold"] = $a_bold;
                    $fields[$idx]["newline"] = $a_newline;
                    $found = true;
                    break;
                }
            }
            if (!$found) {
                $fields[] = array(
                    "field_id" => $a_field_id
                    ,
                    "bold" => $a_bold
                    ,
                    "newline" => $a_newline
                );
            }
 
            $fields = array("substitution" => array("text", serialize($fields)));
            $ilDB->update(
                "adv_md_substitutions",
                $fields,
                array("obj_type" => array("text", $a_obj_type))
            );
        }
        return false;
    }

References $ilDB.

◆ setDBSubstitution()

static ilAdvancedMDClaimingPlugin::setDBSubstitution	(	string	$a_obj_type,
		bool	$a_show_description,
		bool	$a_show_field_names
	)

static

Definition at line 364 of file class.ilAdvancedMDClaimingPlugin.php.

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (self::isValidObjType($a_obj_type, true)) {
            $fields = self::getDBSubstitution($a_obj_type);
 
            $create = false;
            if (!$fields) {
                $create = true;
                $fields = array("obj_type" => array("text", $a_obj_type));
            }
 
            $fields["hide_description"] = array("integer", !$a_show_description);
            $fields["hide_field_names"] = array("integer", !$a_show_field_names);
 
            if ($create) {
                $ilDB->insert("adv_md_substitutions", $fields);
            } else {
                $ilDB->update(
                    "adv_md_substitutions",
                    $fields,
                    array("obj_type" => array("text", $a_obj_type))
                );
            }
 
            return true;
        }
        return false;
    }

References $ilDB.

◆ updateDBField()

static ilAdvancedMDClaimingPlugin::updateDBField	(	int	$a_field_id,
		string	$a_title,
		?string	$a_description = `null`,
		bool	$a_searchable = `false`,
		?array	$a_definition = `null`
	)

static

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

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (self::hasDBField($a_field_id)) {
            $fields = array(
                "field_id" => array("integer", $a_field_id),
                "title" => array("text", trim($a_title)),
                "description" => array("text", trim($a_description)),
                "searchable" => array("integer", (int) $a_searchable)
            );
            if ($a_definition) {
                $fields["field_values"] = array("text", serialize($a_definition));
            }
            $ilDB->update(
                "adv_mdf_definition",
                $fields,
                array("field_id" => array("integer", $a_field_id))
            );
            return true;
        }
 
        return false;
    }

References $ilDB.

◆ updateDBRecord()

static ilAdvancedMDClaimingPlugin::updateDBRecord	(	int	$a_record_id,
		string	$a_title,
		string	$a_description,
		bool	$a_active,
		array	$a_obj_types
	)

static

Update record db entry.

Parameters

int	$a_record_id
string	$a_title
string	$a_description
bool	$a_active
string[]	$a_obj_types

Returns: bool

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

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (self::hasDBRecord($a_record_id)) {
            $fields = array(
                "title" => array("text", trim($a_title)),
                "description" => array("text", trim($a_description)),
                "active" => array("integer", (int) $a_active)
            );
            $ilDB->update(
                "adv_md_record",
                $fields,
                array("record_id" => array("integer", $a_record_id))
            );
 
            $ilDB->manipulate("DELETE FROM adv_md_record_objs" .
                " WHERE record_id = " . $ilDB->quote($a_record_id, "integer"));
 
            self::saveRecordObjTypes($a_record_id, $a_obj_types);
 
            return true;
        }
        return false;
    }

References $ilDB.

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

components/ILIAS/AdvancedMetaData/classes/class.ilAdvancedMDClaimingPlugin.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkPermission()

◆ createDBField()

◆ createDBRecord()

◆ deleteDBField()

◆ deleteDBRecord()

◆ getDBFieldLastPosition()

◆ getDBSubstitution()

◆ hasDBField()

◆ hasDBFieldSubstitution()

◆ hasDBRecord()

◆ isValidObjType()

◆ removeDBFieldSubstitution()

◆ saveRecordObjTypes()

◆ setDBFieldSubstitution()

◆ setDBSubstitution()

◆ updateDBField()

◆ updateDBRecord()