Collaboration diagram for ilAdvancedMDRecord:

Public Member Functions
	__construct (int $a_record_id=0)
	Singleton constructor To create an array of new records (without saving them) call the constructor directly. More...

	setDefaultLanguage (string $language_code)

	getDefaultLanguage ()

	delete ()

	enabledScope ()

	enableScope (bool $a_stat)

	setScopes (array $a_scopes)

	getScopes ()
	Get scopes. More...

	getScopeRefIds ()

	save ()

	update ()

	validate ()

	setGlobalPosition (int $position)

	getGlobalPosition ()

	getRecordId ()

	setActive (bool $a_active)

	isActive ()

	setTitle (string $a_title)

	getTitle ()

	setDescription (string $a_description)

	getDescription ()

	setImportId (string $a_id_string)

	getImportId ()

	setAssignedObjectTypes (array $a_obj_types)

	appendAssignedObjectType (string $a_obj_type, string $a_sub_type, bool $a_optional=false)

	getAssignedObjectTypes ()

	isAssignedObjectType (string $a_obj_type, string $a_sub_type)

	setParentObject (int $a_obj_id)

	getParentObject ()

	toXML (ilXmlWriter $writer)
	To Xml. More...

	__destruct ()

	_clone (array &$a_fields_map, int $a_parent_obj_id=null)

Static Public Member Functions
static	_getInstanceByRecordId (int $a_record_id)

static	_getActiveSearchableRecords ()
	Get active searchable records. More...

static	_lookupTitle (int $a_record_id)

static	_lookupRecordIdByImportId (string $a_ilias_id)

static	_getAssignableObjectTypes (bool $a_include_text=false)
	Get assignable object type @access public. More...

static	_getActivatedObjTypes ()
	get activated obj types More...

static	_getRecords ()
	Get records @access public. More...

static	_getAllRecordsByObjectType ()
	Get records by obj_type Note: this returns only records with no sub types! More...

static	_getActivatedRecordsByObjectType (string $a_obj_type, string $a_sub_type="", bool $a_only_optional=false)
	Get activated records by object type. More...

static	_getSelectedRecordsByObject (string $a_obj_type, int $a_id, string $a_sub_type="", bool $is_ref_id=true)

static	isFilteredByScope ($a_ref_id, array $scopes)
	Check if a given ref id is not filtered by scope restriction. More...

static	_delete ($a_record_id)

static	saveObjRecSelection (int $a_obj_id, string $a_sub_type="", array $a_records=null, bool $a_delete_before=true)
	Save repository object record selection. More...

static	deleteObjRecSelection (int $a_obj_id)
	Delete repository object record selection. More...

static	getObjRecSelection (int $a_obj_id, string $a_sub_type="")
	Get repository object record selection. More...

static	getSharedRecords (int $a_obj1_id, int $a_obj2_id, string $a_sub_type="-")

Protected Member Functions
	setRecordId (int $record_id)

	generateImportId ()
	generate unique record id More...

Protected Attributes
int	$record_id

int	$global_position = 0

string	$import_id = ''

bool	$active = false

string	$title = ''

string	$description = ''

string	$language_default = ''

array	$obj_types = array()

int	$parent_obj = 0

bool	$scope_enabled = false

array	$scopes = []

ilDBInterface	$db

Private Member Functions
	read ()

Static Private Attributes
static	$instances = []

Detailed Description

Definition at line 12 of file class.ilAdvancedMDRecord.php.

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDRecord::__construct ( int $a_record_id = 0 )

Singleton constructor To create an array of new records (without saving them) call the constructor directly.

Otherwise call getInstance... @access public

Parameters

int record id

Definition at line 45 of file class.ilAdvancedMDRecord.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->record_id = $a_record_id;
 
        if ($this->getRecordId()) {
            $this->read();
        }
    }

References $DIC, getRecordId(), and read().

Here is the call graph for this function:

◆ __destruct()

ilAdvancedMDRecord::__destruct ( )

Definition at line 746 of file class.ilAdvancedMDRecord.php.

    {
        unset(self::$instances[$this->getRecordId()]);
    }

References ILIAS\LTI\ToolProvider\getRecordId().

Here is the call graph for this function:

Member Function Documentation

◆ _clone()

ilAdvancedMDRecord::_clone	(	array &	$a_fields_map,
		int	$a_parent_obj_id = `null`
	)

Definition at line 834 of file class.ilAdvancedMDRecord.php.

                                                                             : ilAdvancedMDRecord
    {
        $new_obj = new self();
        $new_obj->setActive($this->isActive());
        $new_obj->setTitle($this->getTitle());
        $new_obj->setDescription($this->getDescription());
        $new_obj->setParentObject($a_parent_obj_id
            ?: $this->getParentObject());
        $new_obj->setAssignedObjectTypes($this->getAssignedObjectTypes());
        $new_obj->setDefaultLanguage($this->getDefaultLanguage());
        $new_obj->save();
 
        foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($this->getRecordId()) as $definition) {
            $new_def = $definition->_clone($new_obj->getRecordId());
            $a_fields_map[$definition->getFieldId()] = $new_def->getFieldId();
        }
 
        $record_translation = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->getRecordId());
        $record_translation->cloneRecord($new_obj->getRecordId());
 
        return $new_obj;
    }

References ilAdvancedMDRecordTranslations\getInstanceByRecordId(), ilAdvancedMDFieldDefinition\getInstancesByRecordId(), ILIAS\LTI\ToolProvider\getRecordId(), and setActive().

Here is the call graph for this function:

◆ _delete()

static ilAdvancedMDRecord::_delete ( $a_record_id )

static

Definition at line 379 of file class.ilAdvancedMDRecord.php.

                                                : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        // Delete fields
        foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($a_record_id) as $field) {
            $field->delete();
        }
 
        $query = "DELETE FROM adv_md_record " .
            "WHERE record_id = " . $ilDB->quote($a_record_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        $query = "DELETE FROM adv_md_record_objs " .
            "WHERE record_id = " . $ilDB->quote($a_record_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, $res, and ilAdvancedMDFieldDefinition\getInstancesByRecordId().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getActivatedObjTypes()

static ilAdvancedMDRecord::_getActivatedObjTypes ( )

static

get activated obj types

Returns: string[]

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

                                                  : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT DISTINCT(obj_type) FROM adv_md_record_objs amo " .
            "JOIN adv_md_record amr ON amo.record_id = amr.record_id " .
            "WHERE active = 1 ";
        $res = $ilDB->query($query);
        $obj_types = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_types[] = (string) $row->obj_type;
        }
        return $obj_types;
    }

References $DIC, $ilDB, $obj_types, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAdvancedSearchGUI\__setSearchOptions(), ilAdvancedSearchGUI\initAdvancedMetaDataForm(), and ilAdvancedMDSettingsGUI\updateSubstitutions().

Here is the caller graph for this function:

◆ _getActivatedRecordsByObjectType()

static ilAdvancedMDRecord::_getActivatedRecordsByObjectType	(	string	$a_obj_type,
		string	$a_sub_type = `""`,
		bool	$a_only_optional = `false`
	)

static

Get activated records by object type.

Returns: ilAdvancedMDRecord[]

Definition at line 240 of file class.ilAdvancedMDRecord.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if ($a_sub_type == "") {
            $a_sub_type = "-";
        }
 
        $records = [];
        $query = "SELECT amro.record_id record_id FROM adv_md_record_objs amro " .
            "JOIN adv_md_record amr ON amr.record_id = amro.record_id " .
            "WHERE active = 1 " .
            "AND obj_type = " . $ilDB->quote($a_obj_type, 'text') . " " .
            "AND sub_type = " . $ilDB->quote($a_sub_type, 'text');
 
        if ($a_only_optional) {
            $query .= " AND optional =" . $ilDB->quote(1, 'integer');
        }
 
        // #16428
        $query .= "ORDER by parent_obj DESC, record_id";
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $records[] = self::_getInstanceByRecordId((int) $row->record_id);
        }
        return $records;
    }

Referenced by ilExerciseExporter\getActiveAdvMDRecords(), ilGlossaryExporter\getActiveAdvMDRecords(), ilSessionExporter\getActiveAdvMDRecords(), ilWikiExporter\getActiveAdvMDRecords(), ilStudyProgrammeTypeDBRepository\getAllAMDRecords(), ilOrgUnitType\getAvailableAdvancedMDRecords(), ilContainerFilterAdvMDAdapter\getAvailableRecordSets(), and ilAdvancedMDRecordGUI\parseRecordSelection().

Here is the caller graph for this function:

◆ _getActiveSearchableRecords()

static ilAdvancedMDRecord::_getActiveSearchableRecords ( )

static

Get active searchable records.

Returns: ilAdvancedMDRecord[]

Definition at line 69 of file class.ilAdvancedMDRecord.php.

                                                        : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT DISTINCT(amr.record_id) FROM adv_md_record amr " .
            "JOIN adv_mdf_definition amfd ON amr.record_id = amfd.record_id " .
            "WHERE searchable = 1 AND active = 1 ";
 
        $res = $ilDB->query($query);
        $records = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $records[] = self::_getInstanceByRecordId((int) $row->record_id);
        }
        return $records;
    }

References $DIC, $ilDB, $query, $res, _getInstanceByRecordId(), and ilDBConstants\FETCHMODE_OBJECT.

Here is the call graph for this function:

◆ _getAllRecordsByObjectType()

static ilAdvancedMDRecord::_getAllRecordsByObjectType ( )

static

Get records by obj_type Note: this returns only records with no sub types!

Returns: array<string, array<int, ilAdvancedMDRecord>

Definition at line 214 of file class.ilAdvancedMDRecord.php.

                                                       : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $records = [];
        $query = "SELECT * FROM adv_md_record_objs WHERE sub_type=" . $ilDB->quote("-", "text");
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $records[(string) $row->obj_type][] = self::_getInstanceByRecordId((int) $row->record_id);
        }
        // #13359 hide ecs if not configured
        if (!ilECSSetting::ecsConfigured()) {
            $filter = ilECSUtils::getPossibleRemoteTypes(false);
            $filter[] = 'rtst';
            $records = array_diff_key($records, array_flip($filter));
        }
 
        return $records;
    }

References $DIC, $ilDB, $query, $res, ilECSSetting\ecsConfigured(), ilDBConstants\FETCHMODE_OBJECT, and ilECSUtils\getPossibleRemoteTypes().

Referenced by ilAdvancedMDSettingsGUI\initFormSubstitutions(), and ilAdvancedMDSettingsGUI\setSubTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAssignableObjectTypes()

static ilAdvancedMDRecord::_getAssignableObjectTypes ( bool $a_include_text = false )

static

Get assignable object type @access public.

Definition at line 127 of file class.ilAdvancedMDRecord.php.

                                                                                  : array
    {
        global $DIC;
 
        $objDefinition = $DIC['objDefinition'];
        $lng = $DIC['lng'];
 
        $types = array();
        $filter = array();
        $amet_types = $objDefinition->getAdvancedMetaDataTypes();
 
        if (!ilECSSetting::ecsConfigured()) {
            $filter = array_merge($filter, ilECSUtils::getPossibleRemoteTypes(false));
            $filter[] = 'rtst';
        }
 
        foreach ($amet_types as $at) {
            if (in_array($at["obj_type"], $filter)) {
                continue;
            }
 
            if ($a_include_text) {
                $text = $lng->txt("obj_" . $at["obj_type"]);
                if ($at["sub_type"] != "") {
                    $lng->loadLanguageModule($at["obj_type"]);
                    $text .= ": " . $lng->txt($at["obj_type"] . "_" . $at["sub_type"]);
                } else {
                    $at["sub_type"] = "-";
                }
                $at["text"] = $text;
            }
 
            $types[] = $at;
        }
 
        sort($types);
        return $types;
    }

References $DIC, $lng, ilECSSetting\ecsConfigured(), and ilECSUtils\getPossibleRemoteTypes().

Referenced by ilAdvancedMDRecordTableGUI\fillRow(), ilAdvancedMDSettingsGUI\initForm(), ilObjectMetaDataGUI\isAdvMDAvailable(), and ilAdvancedMDSettingsGUI\loadRecordFormData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getInstanceByRecordId()

static ilAdvancedMDRecord::_getInstanceByRecordId ( int $a_record_id )

static

Definition at line 57 of file class.ilAdvancedMDRecord.php.

                                                                   : ilAdvancedMDRecord
    {
        if (isset(self::$instances[$a_record_id])) {
            return self::$instances[$a_record_id];
        }
        return self::$instances[$a_record_id] = new ilAdvancedMDRecord($a_record_id);
    }

Referenced by _getActiveSearchableRecords(), _getRecords(), ilAdvancedMDSettingsGUI\confirmDeleteRecords(), ilAdvancedMDSettingsGUI\deleteRecords(), ilAdvancedMDSettingsGUI\exportRecords(), ilAdvancedMDRecordTableGUI\fillRow(), ilContainerFilterUtil\getContainerRecordTitle(), ilAdvancedMDFieldDefinitionSelect\import(), ilAdvancedMDFieldDefinitionText\importValueFromXML(), ilAdvancedMDSettingsGUI\initRecordObject(), ilAdvancedMDRecordParser\initRecordObject(), ilAdvancedMDFieldTranslations\read(), ilAdvancedMDRecordTranslations\read(), ilAdvancedMDFieldDefinitionSelect\saveOptionTranslations(), ilAdvancedMDSettingsGUI\updateRecords(), ilAdvancedMDFieldDefinition\useDefaultLanguageMode(), and ilAdvancedMDRecordXMLWriter\write().

Here is the caller graph for this function:

◆ _getRecords()

static ilAdvancedMDRecord::_getRecords ( )

static

Get records @access public.

Parameters

array array of record objects

Returns: ilAdvancedMDRecord[]

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

                                        : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT record_id FROM adv_md_record ORDER BY gpos ";
        $res = $ilDB->query($query);
        $records = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $records[] = ilAdvancedMDRecord::_getInstanceByRecordId((int) $row->record_id);
        }
        return $records;
    }

References $DIC, $ilDB, $query, $res, _getInstanceByRecordId(), and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilLuceneAdvancedSearchFields\getFields(), and ilAdvancedMDSettingsGUI\getParsedRecordObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getSelectedRecordsByObject()

static ilAdvancedMDRecord::_getSelectedRecordsByObject	(	string	$a_obj_type,
		int	$a_id,
		string	$a_sub_type = `""`,
		bool	$is_ref_id = `true`
	)

static

Parameters

string	$a_obj_type
int	$a_id
string	$a_sub_type
bool	$is_ref_id

Returns: array<int, ilAdvancedMDRecord>

Definition at line 281 of file class.ilAdvancedMDRecord.php.

     : array {
        $records = array();
 
        if ($a_sub_type == "") {
            $a_sub_type = "-";
        }
 
        $a_obj_id = $is_ref_id
            ? ilObject::_lookupObjId($a_id)
            : $a_id;
 
        // object-wide metadata configuration setting
        $config_setting = ilContainer::_lookupContainerSetting(
            $a_obj_id,
            ilObjectServiceSettingsGUI::CUSTOM_METADATA,
            ''
        );
 
        $optional = array();
        foreach (self::_getActivatedRecordsByObjectType($a_obj_type, $a_sub_type) as $record) {
            // check scope
            if ($is_ref_id && self::isFilteredByScope($a_id, $record->getScopes())) {
                continue;
            }
            foreach ($record->getAssignedObjectTypes() as $item) {
                if ($record->getParentObject()) {
                    // only matching local records
                    if ($record->getParentObject() != $a_obj_id) {
                        continue;
                    } // if object-wide setting is off, ignore local records
                    elseif (!$config_setting) {
                        continue;
                    }
                }
 
                if ($item['obj_type'] == $a_obj_type &&
                    $item['sub_type'] == $a_sub_type) {
                    if ($item['optional']) {
                        $optional[] = $record->getRecordId();
                    }
                    $records[$record->getRecordId()] = $record;
                }
            }
        }
 
        if ($optional) {
            if (!$config_setting && !in_array($a_sub_type, array("orgu_type", "prg_type"))) { //#16925 + #17777
                $selected = array();
            } else {
                $selected = self::getObjRecSelection($a_obj_id, $a_sub_type);
            }
            foreach ($optional as $record_id) {
                if (!in_array($record_id, $selected)) {
                    unset($records[$record_id]);
                }
            }
        }
 
        $orderings = new ilAdvancedMDRecordObjectOrderings();
        $records = $orderings->sortRecords($records, $a_obj_id);
 
        return $records;
    }

Referenced by ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), ilAdvancedMDRecordGUI\getActiveRecords(), ilPCAMDFormGUI\getAdvRecords(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilObjectMetaDataGUI\getBlockHTML(), ilObjectMetaDataGUI\getKeyValueList(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilObjectMetaDataGUI\hasActiveRecords(), ilObjWikiGUI\initSettingsForm(), and ilAdvancedMDValues\preloadedRead().

Here is the caller graph for this function:

◆ _lookupRecordIdByImportId()

static ilAdvancedMDRecord::_lookupRecordIdByImportId ( string $a_ilias_id )

static

Definition at line 107 of file class.ilAdvancedMDRecord.php.

                                                                        : int
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT record_id FROM adv_md_record " .
            "WHERE import_id = " . $ilDB->quote($a_ilias_id, 'text') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->record_id;
        }
        return 0;
    }

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAdvancedMDRecordParser\extractRecordId().

Here is the caller graph for this function:

◆ _lookupTitle()

static ilAdvancedMDRecord::_lookupTitle ( int $a_record_id )

static

Definition at line 87 of file class.ilAdvancedMDRecord.php.

                                                         : string
    {
        static $title_cache = array();
 
        if (isset($title_cache[$a_record_id])) {
            return $title_cache[$a_record_id];
        }
 
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT title FROM adv_md_record " .
            "WHERE record_id = " . $ilDB->quote($a_record_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
        return $title_cache[$a_record_id] = (string) $row->title;
    }

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAdvancedMDSettingsGUI\initFormSubstitutions(), and ilECSSettingsGUI\prepareFieldSelection().

Here is the caller graph for this function:

◆ appendAssignedObjectType()

ilAdvancedMDRecord::appendAssignedObjectType	(	string	$a_obj_type,
		string	$a_sub_type,
		bool	$a_optional = `false`
	)

Definition at line 621 of file class.ilAdvancedMDRecord.php.

                                                                                                              : void
    {
        $this->obj_types[] = array(
            "obj_type" => $a_obj_type,
            "sub_type" => $a_sub_type,
            "optional" => $a_optional
        );
    }

◆ delete()

ilAdvancedMDRecord::delete ( )

Definition at line 417 of file class.ilAdvancedMDRecord.php.

                            : void
    {
        ilAdvancedMDRecord::_delete($this->getRecordId());
        ilAdvancedMDRecordScope::deleteByRecordId($this->getRecordId());
    }

References _delete(), ilAdvancedMDRecordScope\deleteByRecordId(), and ILIAS\LTI\ToolProvider\getRecordId().

Here is the call graph for this function:

◆ deleteObjRecSelection()

static ilAdvancedMDRecord::deleteObjRecSelection ( int $a_obj_id )

static

Delete repository object record selection.

Definition at line 796 of file class.ilAdvancedMDRecord.php.

                                                               : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $ilDB->manipulate("DELETE FROM adv_md_obj_rec_select WHERE " .
            " obj_id = " . $ilDB->quote($a_obj_id, "integer"));
    }

References $DIC, and $ilDB.

Referenced by ilAdvancedMDSettingsGUI\updateRecords().

Here is the caller graph for this function:

◆ enabledScope()

ilAdvancedMDRecord::enabledScope ( )

Definition at line 423 of file class.ilAdvancedMDRecord.php.

                                  : bool
    {
        return $this->scope_enabled;
    }

◆ enableScope()

ilAdvancedMDRecord::enableScope ( bool $a_stat )

Definition at line 428 of file class.ilAdvancedMDRecord.php.

                                             : void
    {
        $this->scope_enabled = $a_stat;
    }

◆ generateImportId()

ilAdvancedMDRecord::generateImportId ( )

protected

generate unique record id

Definition at line 741 of file class.ilAdvancedMDRecord.php.

                                         : string
    {
        return 'il_' . IL_INST_ID . '_adv_md_record_' . $this->getRecordId();
    }

References ILIAS\LTI\ToolProvider\getRecordId(), and IL_INST_ID.

Here is the call graph for this function:

◆ getAssignedObjectTypes()

ilAdvancedMDRecord::getAssignedObjectTypes ( )

Returns: array<int, array{obj_type: string, sub_type: string, optional: bool}>

Definition at line 633 of file class.ilAdvancedMDRecord.php.

                                            : array
    {
        return $this->obj_types;
    }

◆ getDefaultLanguage()

ilAdvancedMDRecord::getDefaultLanguage ( )

Definition at line 412 of file class.ilAdvancedMDRecord.php.

                                        : string
    {
        return $this->language_default;
    }

◆ getDescription()

ilAdvancedMDRecord::getDescription ( )

Definition at line 597 of file class.ilAdvancedMDRecord.php.

                                    : string
    {
        return $this->description;
    }

◆ getGlobalPosition()

ilAdvancedMDRecord::getGlobalPosition ( )

Definition at line 562 of file class.ilAdvancedMDRecord.php.

                                       : int
    {
        return $this->global_position;
    }

◆ getImportId()

ilAdvancedMDRecord::getImportId ( )

Definition at line 607 of file class.ilAdvancedMDRecord.php.

                                 : string
    {
        return $this->import_id;
    }

◆ getObjRecSelection()

static ilAdvancedMDRecord::getObjRecSelection	(	int	$a_obj_id,
		string	$a_sub_type = `""`
	)

static

Get repository object record selection.

Parameters

int	$a_obj_id	object id if repository object
array	$a_records	array of record ids that are selected (in use) by the object

Returns: int[]

Definition at line 812 of file class.ilAdvancedMDRecord.php.

                                                                                     : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if ($a_sub_type == "") {
            $a_sub_type = "-";
        }
 
        $recs = array();
        $set = $ilDB->query(
            $r = "SELECT * FROM adv_md_obj_rec_select " .
                " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
                " AND sub_type = " . $ilDB->quote($a_sub_type, "text")
        );
        while ($rec = $ilDB->fetchAssoc($set)) {
            $recs[] = (int) $rec["rec_id"];
        }
        return $recs;
    }

References $DIC, $ilDB, and ILIAS\Repository\int().

Referenced by ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), ilGlossaryExporter\getActiveAdvMDRecords(), ilWikiExporter\getActiveAdvMDRecords(), ilAdvancedMDSettingsGUI\getParsedRecordObjects(), getSharedRecords(), and ilAdvancedMDRecordGUI\parseRecordSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParentObject()

ilAdvancedMDRecord::getParentObject ( )

Definition at line 654 of file class.ilAdvancedMDRecord.php.

                                     : int
    {
        return $this->parent_obj;
    }

◆ getRecordId()

ilAdvancedMDRecord::getRecordId ( )

Definition at line 567 of file class.ilAdvancedMDRecord.php.

                                 : int
    {
        return $this->record_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ getScopeRefIds()

ilAdvancedMDRecord::getScopeRefIds ( )

Returns: int[]

Definition at line 453 of file class.ilAdvancedMDRecord.php.

                                    : array
    {
        $ref_ids = [];
        foreach ($this->scopes as $scope) {
            $ref_ids[] = $scope->getRefId();
        }
        return $ref_ids;
    }

References $scope.

◆ getScopes()

ilAdvancedMDRecord::getScopes ( )

Get scopes.

Returns: ilAdvancedMDRecordScope[]

Definition at line 445 of file class.ilAdvancedMDRecord.php.

                               : array
    {
        return $this->scopes;
    }

References $scopes.

◆ getSharedRecords()

static ilAdvancedMDRecord::getSharedRecords	(	int	$a_obj1_id,
		int	$a_obj2_id,
		string	$a_sub_type = `"-"`
	)

static

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

                                                                                                     : array
    {
        $obj_type = ilObject::_lookupType($a_obj1_id);
        $sel = array_intersect(
            ilAdvancedMDRecord::getObjRecSelection($a_obj1_id, $a_sub_type),
            ilAdvancedMDRecord::getObjRecSelection($a_obj2_id, $a_sub_type)
        );
 
        $res = array();
 
        foreach (self::_getRecords() as $record) {
            // local records cannot be shared
            if ($record->getParentObject()) {
                continue;
            }
 
            // :TODO: inactive records can be ignored?
            if (!$record->isActive()) {
                continue;
            }
 
            // parse assigned types
            foreach ($record->getAssignedObjectTypes() as $item) {
                if ($item["obj_type"] == $obj_type &&
                    $item["sub_type"] == $a_sub_type) {
                    // mandatory
                    if (!$item["optional"]) {
                        $res[] = $record->getRecordId();
                    } // optional
                    elseif (in_array($record->getRecordId(), $sel)) {
                        $res[] = $record->getRecordId();
                    }
                }
            }
        }
 
        return $res;
    }

References $res, ilObject\_lookupType(), and getObjRecSelection().

Here is the call graph for this function:

◆ getTitle()

ilAdvancedMDRecord::getTitle ( )

Definition at line 587 of file class.ilAdvancedMDRecord.php.

                              : string
    {
        return $this->title;
    }

◆ isActive()

ilAdvancedMDRecord::isActive ( )

Definition at line 577 of file class.ilAdvancedMDRecord.php.

                              : bool
    {
        return $this->active;
    }

◆ isAssignedObjectType()

ilAdvancedMDRecord::isAssignedObjectType	(	string	$a_obj_type,
		string	$a_sub_type
	)

Definition at line 638 of file class.ilAdvancedMDRecord.php.

                                                                                : bool
    {
        foreach ($this->getAssignedObjectTypes() as $t) {
            if ($t["obj_type"] == $a_obj_type &&
                $t["sub_type"] == $a_sub_type) {
                return true;
            }
        }
        return false;
    }

◆ isFilteredByScope()

static ilAdvancedMDRecord::isFilteredByScope	(		$a_ref_id,
		array	$scopes
	)

static

Check if a given ref id is not filtered by scope restriction.

Parameters

int	$a_ref_id
ilAdvancedMDRecordScope[]	$scopes

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

                                                                      : bool
    {
        $tree = $GLOBALS['DIC']->repositoryTree();
        $logger = $GLOBALS['DIC']->logger()->amet();
 
        if (!count($scopes)) {
            return false;
        }
        foreach ($scopes as $scope) {
            $logger->debug('Comparing: ' . $a_ref_id . ' with: ' . $scope->getRefId());
            if ($scope->getRefId() == $a_ref_id) {
                $logger->debug('Elements are equal. No scope restrictions.');
                return false;
            }
            if ($tree->getRelation($scope->getRefId(), $a_ref_id) == ilTree::RELATION_PARENT) {
                $logger->debug('Node is child node. No scope restrictions.');
                return false;
            }
        }
        $logger->info('Scope filter matches.');
 
        return true;
    }

References $GLOBALS, $scope, $scopes, and ilTree\RELATION_PARENT.

Referenced by ilAdvancedMDSettingsGUI\getParsedRecordObjects().

Here is the caller graph for this function:

◆ read()

ilAdvancedMDRecord::read ( )

private

Definition at line 702 of file class.ilAdvancedMDRecord.php.

                           : void
    {
        $query = "SELECT * FROM adv_md_record " .
            "WHERE record_id = " . $this->db->quote($this->getRecordId(), 'integer') . " ";
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setImportId((string) $row->import_id);
            $this->setActive((bool) $row->active);
            $this->setTitle((string) $row->title);
            $this->setDescription((string) $row->description);
            $this->setParentObject((int) $row->parent_obj);
            $this->setGlobalPosition((int) $row->gpos);
            $this->setDefaultLanguage((string) $row->lang_default);
        }
        $query = "SELECT * FROM adv_md_record_objs " .
            "WHERE record_id = " . $this->db->quote($this->getRecordId(), 'integer') . " ";
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->obj_types[] = array(
                "obj_type" => (string) $row->obj_type,
                "sub_type" => (string) $row->sub_type,
                "optional" => (bool) $row->optional
            );
        }
 
        $query = 'SELECT scope_id FROM adv_md_record_scope ' .
            'WHERE record_id = ' . $this->db->quote($this->record_id, ilDBConstants::T_INTEGER);
        $res = $this->db->query($query);
        $this->scope_enabled = false;
        $this->scopes = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->scope_enabled = true;
            $this->scopes[] = new ilAdvancedMDRecordScope((int) $row->scope_id);
        }
    }

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\LTI\ToolProvider\getRecordId(), and ilDBConstants\T_INTEGER.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilAdvancedMDRecord::save ( )

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

                          : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        // Save import id if given
        $next_id = $ilDB->nextId('adv_md_record');
 
        $query = "INSERT INTO adv_md_record (record_id,import_id,active,title,description,parent_obj,lang_default) " .
            "VALUES(" .
            $ilDB->quote($next_id, 'integer') . ", " .
            $this->db->quote($this->getImportId(), 'text') . ", " .
            $this->db->quote($this->isActive(), 'integer') . ", " .
            $this->db->quote($this->getTitle(), 'text') . ", " .
            $this->db->quote($this->getDescription(), 'text') . ", " .
            $this->db->quote($this->getParentObject(), 'integer') . ", " .
            $this->db->quote($this->getDefaultLanguage(), ilDBConstants::T_TEXT) .
            ")";
        $res = $ilDB->manipulate($query);
        $this->record_id = $next_id;
 
        if (!strlen($this->getImportId())) {
            // set import id to default value
            $query = "UPDATE adv_md_record " .
                "SET import_id = " . $this->db->quote($this->generateImportId(), 'text') . " " .
                "WHERE record_id = " . $this->db->quote($this->record_id, 'integer') . " ";
            $res = $ilDB->manipulate($query);
        }
 
        foreach ($this->getAssignedObjectTypes() as $type) {
            global $DIC;
            $ilDB = $DIC['ilDB'];
            $query = "INSERT INTO adv_md_record_objs (record_id,obj_type,sub_type,optional) " .
                "VALUES( " .
                $this->db->quote($this->getRecordId(), 'integer') . ", " .
                $this->db->quote($type["obj_type"], 'text') . ", " .
                $this->db->quote($type["sub_type"], 'text') . ", " .
                $this->db->quote($type["optional"], 'integer') . " " .
                ")";
            $res = $ilDB->manipulate($query);
        }
 
        foreach ($this->getScopes() as $scope) {
            $scope->setRecordId($this->getRecordId());
            $scope->save();
        }
    }

References $DIC, $ilDB, $query, $res, $scope, $type, ILIAS\LTI\ToolProvider\getRecordId(), and ilDBConstants\T_TEXT.

Here is the call graph for this function:

◆ saveObjRecSelection()

static ilAdvancedMDRecord::saveObjRecSelection	(	int	$a_obj_id,
		string	$a_sub_type = `""`,
		array	$a_records = `null`,
		bool	$a_delete_before = `true`
	)

static

Save repository object record selection.

Parameters

int	$a_obj_id	object id if repository object
string	$a_sub_type	subtype
int[]	$a_records	array of record ids that are selected (in use) by the object
bool	$a_delete_before	delete before update

Returns: void

Definition at line 759 of file class.ilAdvancedMDRecord.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if ($a_sub_type == "") {
            $a_sub_type = "-";
        }
 
        if ($a_delete_before) {
            $ilDB->manipulate("DELETE FROM adv_md_obj_rec_select WHERE " .
                " obj_id = " . $ilDB->quote($a_obj_id, "integer") .
                " AND sub_type = " . $ilDB->quote($a_sub_type, "text"));
        }
 
        if (is_array($a_records)) {
            foreach ($a_records as $r) {
                if ($r > 0) {
                    $ilDB->manipulate("INSERT INTO adv_md_obj_rec_select " .
                        "(obj_id, rec_id, sub_type) VALUES (" .
                        $ilDB->quote($a_obj_id, "integer") . "," .
                        $ilDB->quote($r, "integer") . "," .
                        $ilDB->quote($a_sub_type, "text") .
                        ")");
                }
            }
        }
    }

Referenced by ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), ilAdvancedMetaDataImporter\importXmlRepresentation(), ilAdvancedMDRecordGUI\saveSelection(), ilObjOrgUnit\update(), ilObjStudyProgramme\update(), and ilAdvancedMDSettingsGUI\updateRecords().

Here is the caller graph for this function:

◆ setActive()

ilAdvancedMDRecord::setActive ( bool $a_active )

Definition at line 572 of file class.ilAdvancedMDRecord.php.

                                             : void
    {
        $this->active = $a_active;
    }

Referenced by _clone().

Here is the caller graph for this function:

◆ setAssignedObjectTypes()

ilAdvancedMDRecord::setAssignedObjectTypes ( array $a_obj_types )

Parameters

string[]

Todo:: is this format of $a_obj_types correct?

Definition at line 616 of file class.ilAdvancedMDRecord.php.

                                                              : void
    {
        $this->obj_types = $a_obj_types;
    }

◆ setDefaultLanguage()

ilAdvancedMDRecord::setDefaultLanguage ( string $language_code )

Parameters

string $language_code

Definition at line 407 of file class.ilAdvancedMDRecord.php.

                                                             : void
    {
        $this->language_default = $language_code;
    }

◆ setDescription()

ilAdvancedMDRecord::setDescription ( string $a_description )

Definition at line 592 of file class.ilAdvancedMDRecord.php.

                                                         : void
    {
        $this->description = $a_description;
    }

◆ setGlobalPosition()

ilAdvancedMDRecord::setGlobalPosition ( int $position )

Definition at line 557 of file class.ilAdvancedMDRecord.php.

                                                    : void
    {
        $this->global_position = $position;
    }

◆ setImportId()

ilAdvancedMDRecord::setImportId ( string $a_id_string )

Definition at line 602 of file class.ilAdvancedMDRecord.php.

                                                    : void
    {
        $this->import_id = $a_id_string;
    }

◆ setParentObject()

ilAdvancedMDRecord::setParentObject ( int $a_obj_id )

Definition at line 649 of file class.ilAdvancedMDRecord.php.

                                                  : void
    {
        $this->parent_obj = $a_obj_id;
    }

◆ setRecordId()

ilAdvancedMDRecord::setRecordId ( int $record_id )

protected

Definition at line 399 of file class.ilAdvancedMDRecord.php.

                                                  : void
    {
        $this->record_id = $record_id;
    }

◆ setScopes()

ilAdvancedMDRecord::setScopes ( array $a_scopes )

Parameters

ilAdvancedMDRecordScope[]

Definition at line 436 of file class.ilAdvancedMDRecord.php.

                                              : void
    {
        $this->scopes = $a_scopes;
    }

◆ setTitle()

ilAdvancedMDRecord::setTitle ( string $a_title )

Definition at line 582 of file class.ilAdvancedMDRecord.php.

                                             : void
    {
        $this->title = $a_title;
    }

◆ toXML()

ilAdvancedMDRecord::toXML ( ilXmlWriter $writer )

To Xml.

This method writes only the subset Record (including all fields) Use class.ilAdvancedMDRecordXMLWriter to generate a complete xml presentation.

Definition at line 664 of file class.ilAdvancedMDRecord.php.

                                              : void
    {
        $writer->xmlStartTag('Record', array('active' => $this->isActive() ? 1 : 0,
                                             'id' => $this->generateImportId()
        ));
        $writer->xmlElement('Title', null, $this->getTitle());
        $writer->xmlElement('Description', null, $this->getDescription());
 
        $translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->getRecordId());
        $translations->toXML($writer);
 
        foreach ($this->getAssignedObjectTypes() as $obj_type) {
            $optional = array("optional" => $obj_type["optional"]);
            if ($obj_type["sub_type"] == "") {
                $writer->xmlElement('ObjectType', $optional, $obj_type["obj_type"]);
            } else {
                $writer->xmlElement('ObjectType', $optional, $obj_type["obj_type"] . ":" . $obj_type["sub_type"]);
            }
        }
 
        // scopes
        if (count($this->getScopeRefIds())) {
            $writer->xmlStartTag('Scope');
        }
        foreach ($this->getScopeRefIds() as $ref_id) {
            $type = ilObject::_lookupType(ilObject::_lookupObjId($ref_id));
            $writer->xmlElement('ScopeEntry', ['id' => 'il_' . IL_INST_ID . '_' . $type . '_' . $ref_id]);
        }
        if (count($this->getScopeRefIds())) {
            $writer->xmlEndTag('Scope');
        }
 
        foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($this->getRecordId()) as $definition) {
            $definition->toXML($writer);
        }
        $writer->xmlEndTag('Record');
    }

References $ref_id, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), ilAdvancedMDFieldDefinition\getInstancesByRecordId(), ILIAS\LTI\ToolProvider\getRecordId(), IL_INST_ID, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

◆ update()

ilAdvancedMDRecord::update ( )

Definition at line 511 of file class.ilAdvancedMDRecord.php.

                            : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "UPDATE adv_md_record " .
            "SET active = " . $this->db->quote($this->isActive(), 'integer') . ", " .
            "title = " . $this->db->quote($this->getTitle(), 'text') . ", " .
            "description = " . $this->db->quote($this->getDescription(), 'text') . ", " .
            'gpos = ' . $this->db->quote($this->getGlobalPosition(), 'integer') . ', ' .
            'lang_default = ' . $this->db->quote($this->getDefaultLanguage(), ilDBConstants::T_TEXT) . ' ' .
            "WHERE record_id = " . $this->db->quote($this->getRecordId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        // Delete assignments
        $query = "DELETE FROM adv_md_record_objs " .
            "WHERE record_id = " . $this->db->quote($this->getRecordId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        // Insert assignments
        foreach ($this->getAssignedObjectTypes() as $type) {
            $query = "INSERT INTO adv_md_record_objs (record_id,obj_type,sub_type,optional) " .
                "VALUES ( " .
                $this->db->quote($this->getRecordId(), 'integer') . ", " .
                $this->db->quote($type["obj_type"], 'text') . ", " .
                $this->db->quote($type["sub_type"], 'text') . ", " .
                $this->db->quote($type["optional"], 'integer') . " " .
                ")";
            $res = $ilDB->manipulate($query);
        }
        ilAdvancedMDRecordScope::deleteByRecordId($this->getRecordId());
        foreach ($this->getScopes() as $scope) {
            $scope->setRecordId($this->getRecordId());
            $scope->save();
        }
    }

References $DIC, $ilDB, $query, $res, $scope, $type, ilAdvancedMDRecordScope\deleteByRecordId(), ILIAS\LTI\ToolProvider\getRecordId(), and ilDBConstants\T_TEXT.

Here is the call graph for this function:

◆ validate()

ilAdvancedMDRecord::validate ( )

Definition at line 549 of file class.ilAdvancedMDRecord.php.

                              : bool
    {
        if (!strlen($this->getTitle())) {
            return false;
        }
        return true;
    }

Field Documentation

◆ $active

bool ilAdvancedMDRecord::$active = false

protected

Definition at line 20 of file class.ilAdvancedMDRecord.php.

◆ $db

ilDBInterface ilAdvancedMDRecord::$db

protected

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

◆ $description

string ilAdvancedMDRecord::$description = ''

protected

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

◆ $global_position

int ilAdvancedMDRecord::$global_position = 0

protected

Definition at line 17 of file class.ilAdvancedMDRecord.php.

◆ $import_id

string ilAdvancedMDRecord::$import_id = ''

protected

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

◆ $instances

ilAdvancedMDRecord::$instances = []

staticprivate

Definition at line 14 of file class.ilAdvancedMDRecord.php.

◆ $language_default

string ilAdvancedMDRecord::$language_default = ''

protected

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

◆ $obj_types

array ilAdvancedMDRecord::$obj_types = array()

protected

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

Referenced by _getActivatedObjTypes().

◆ $parent_obj

int ilAdvancedMDRecord::$parent_obj = 0

protected

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

◆ $record_id

int ilAdvancedMDRecord::$record_id

protected

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

◆ $scope_enabled

bool ilAdvancedMDRecord::$scope_enabled = false

protected

Definition at line 30 of file class.ilAdvancedMDRecord.php.

◆ $scopes

array ilAdvancedMDRecord::$scopes = []

protected

Definition at line 34 of file class.ilAdvancedMDRecord.php.

◆ $title

string ilAdvancedMDRecord::$title = ''

protected

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

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

Services/AdvancedMetaData/classes/Record/class.ilAdvancedMDRecord.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ _clone()

◆ _delete()

◆ _getActivatedObjTypes()

◆ _getActivatedRecordsByObjectType()

◆ _getActiveSearchableRecords()

◆ _getAllRecordsByObjectType()

◆ _getAssignableObjectTypes()

◆ _getInstanceByRecordId()

◆ _getRecords()

◆ _getSelectedRecordsByObject()

◆ _lookupRecordIdByImportId()

◆ _lookupTitle()

◆ appendAssignedObjectType()

◆ delete()

◆ deleteObjRecSelection()

◆ enabledScope()

◆ enableScope()

◆ generateImportId()

◆ getAssignedObjectTypes()

◆ getDefaultLanguage()

◆ getDescription()

◆ getGlobalPosition()

◆ getImportId()

◆ getObjRecSelection()

◆ getParentObject()

◆ getRecordId()

◆ getScopeRefIds()

◆ getScopes()

◆ getSharedRecords()

◆ getTitle()

◆ isActive()

◆ isAssignedObjectType()

◆ isFilteredByScope()

◆ read()

◆ save()

◆ saveObjRecSelection()

◆ setActive()

◆ setAssignedObjectTypes()

◆ setDefaultLanguage()

◆ setDescription()

◆ setGlobalPosition()

◆ setImportId()

◆ setParentObject()

◆ setRecordId()

◆ setScopes()

◆ setTitle()

◆ toXML()

◆ update()

◆ validate()

Field Documentation

◆ $active

◆ $db

◆ $description

◆ $global_position

◆ $import_id

◆ $instances

◆ $language_default

◆ $obj_types

◆ $parent_obj

◆ $record_id

◆ $scope_enabled

◆ $scopes

◆ $title