Collaboration diagram for ilAdvancedMDRecord:

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

	delete ()
	Delete. More...

	enabledScope ()
	Is scope enabled. More...

	enableScope ($a_stat)
	Enable scope restrictions. More...

	setScopes (array $a_scopes)
	Set scopes. More...

	getScopes ()
	Get scopes. More...

	getScopeRefIds ()
	Get scope gef_ids. More...

	save ()
	save More...

	update ()
	update More...

	validate ()
	Validate settings. More...

	setGlobalPosition (int $position)
	Set global position. More...

	getGlobalPosition ()

	getRecordId ()
	Get record id. More...

	setActive ($a_active)
	Set active. More...

	isActive ()
	Check if record is active. More...

	setTitle ($a_title)
	Set title. More...

	getTitle ()
	get title More...

	setDescription ($a_description)
	set description More...

	getDescription ()
	get description More...

	setImportId ($a_id_string)
	set import id More...

	getImportId ()
	get import id More...

	setAssignedObjectTypes ($a_obj_types)
	Set assigned object types. More...

	appendAssignedObjectType ($a_obj_type, $a_sub_type, $a_optional=false)
	append assigned object types More...

	getAssignedObjectTypes ()
	Get assigned object types. More...

	isAssignedObjectType ($a_obj_type, $a_sub_type)
	Is assigned object type? More...

	setParentObject ($a_obj_id)

	getParentObject ()

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

	__destruct ()
	Destructor. More...

	_clone (array &$a_fields_map, $a_parent_obj_id=null)
	Clone record. More...

Static Public Member Functions
static	_getInstanceByRecordId ($a_record_id)
	Get instance by record id. More...

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

static	_lookupTitle ($a_record_id)
	Lookup title. More...

static	_lookupRecordIdByImportId ($a_ilias_id)
	Lookup record Id by import id. More...

static	_getAssignableObjectTypes ($a_include_text=false)
	Get assignable object type. More...

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

static	_getRecords ()
	Get records. More...

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

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

static	_getSelectedRecordsByObject ($a_obj_type, $a_ref_id, $a_sub_type="")
	Get selected records by object. More...

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)
	Delete record and all related data. More...

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

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

static	getSharedRecords ($a_obj1_id, $a_obj2_id, $a_sub_type="-")
	Get shared records. More...

Protected Member Functions
	generateImportId ()
	generate unique record id More...

Protected Attributes
	$record_id

	$global_position

	$import_id

	$active

	$title

	$description

	$obj_types = array()

	$db = null

	$parent_obj

	$scope_enabled = false

	$scopes = []

Private Member Functions
	read ()
	read record and assiged object types More...

Static Private Attributes
static	$instances = array()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDRecord::__construct ( $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 52 of file class.ilAdvancedMDRecord.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->record_id = $a_record_id;
        $this->db = $ilDB;
        
        if ($this->getRecordId()) {
            $this->read();
        }
    }

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

Here is the call graph for this function:

◆ __destruct()

ilAdvancedMDRecord::__destruct ( )

Destructor.

@access public

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

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

References getRecordId().

Here is the call graph for this function:

Member Function Documentation

◆ _clone()

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

Clone record.

Parameters

array	&$a_fields_map
type	$a_parent_obj_id

Returns: self

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

    {
        $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
            ? $a_parent_obj_id
            : $this->getParentObject());
        $new_obj->setAssignedObjectTypes($this->getAssignedObjectTypes());
        $new_obj->save();
        
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($this->getRecordId()) as $definition) {
            $new_def = $definition->_clone($new_obj->getRecordId());
            $a_fields_map[$definition->getFieldId()] = $new_def->getFieldId();
        }
 
        return $new_obj;
    }

References getAssignedObjectTypes(), getDescription(), ilAdvancedMDFieldDefinition\getInstancesByRecordId(), getParentObject(), getRecordId(), getTitle(), and isActive().

Here is the call graph for this function:

◆ _delete()

static ilAdvancedMDRecord::_delete ( $a_record_id )

static

Delete record and all related data.

@access public

Parameters

int record id

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

    {
        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

@access public

Parameters

string obj types

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

    {
        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);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_types[] = $row->obj_type;
        }
        return $obj_types ? $obj_types : array();
    }

References $DIC, $ilDB, $obj_types, $query, $res, $row, 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	(	$a_obj_type,
		$a_sub_type = `""`,
		$a_only_optional = `false`
	)

static

Get activated records by object type.

@access public

Parameters

string obj_type

Returns: ilAdvancedMDRecord[]

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $records = array();
        
        if ($a_sub_type == "") {
            $a_sub_type = "-";
        }
        
        $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($row->record_id);
        }
 
        return $records;
    }

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

Referenced by ilSoapInstallationInfoXMLWriter\__buildClient(), ilGlossaryExporter\getActiveAdvMDRecords(), ilSessionExporter\getActiveAdvMDRecords(), ilWikiExporter\getActiveAdvMDRecords(), ilOrgUnitType\getAvailableAdvancedMDRecords(), ilStudyProgrammeType\getAvailableAdvancedMDRecords(), ilSoapAdministration\getNIC(), and ilAdvancedMDRecordGUI\parseRecordSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getActiveSearchableRecords()

static ilAdvancedMDRecord::_getActiveSearchableRecords ( )

static

Get active searchable records.

@access public

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

    {
        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);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $records[] = self::_getInstanceByRecordId($row->record_id);
        }
        return $records ? $records : array();
    }

References $DIC, $ilDB, $query, $records, $res, $row, _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! @access public.

Parameters

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $records = array();
        
        $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[$row->obj_type][] = self::_getInstanceByRecordId($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, $records, $res, $row, _getInstanceByRecordId(), 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 ( $a_include_text = false )

static

Get assignable object type.

@access public

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

    {
        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, $text, ilECSSetting\ecsConfigured(), and ilECSUtils\getPossibleRemoteTypes().

Referenced by ilSoapInstallationInfoXMLWriter\__buildClient(), ilAdvancedMDRecordTableGUI\fillRow(), ilSoapAdministration\getNIC(), ilAdvancedMDSettingsGUI\initForm(), and ilObjectMetaDataGUI\isAdvMDAvailable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getInstanceByRecordId()

static ilAdvancedMDRecord::_getInstanceByRecordId ( $a_record_id )

static

Get instance by record id.

@access public

Parameters

int record id

Returns: ilAdvancedMDRecord

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

    {
        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 _getActivatedRecordsByObjectType(), _getActiveSearchableRecords(), _getAllRecordsByObjectType(), _getRecords(), ilAdvancedMDSettingsGUI\confirmDeleteRecords(), ilAdvancedMDSettingsGUI\deleteRecords(), ilAdvancedMDSettingsGUI\exportRecords(), ilAdvancedMDRecordTableGUI\fillRow(), ilAdvancedMDRecordParser\initRecordObject(), ilAdvancedMDSettingsGUI\initRecordObject(), and ilAdvancedMDSettingsGUI\updateRecords().

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 236 of file class.ilAdvancedMDRecord.php.

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

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

Referenced by ilAdvancedMDValues\_cloneValues(), 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	(	$a_obj_type,
		$a_ref_id,
		$a_sub_type = `""`
	)

static

Get selected records by object.

Parameters

string	$a_obj_type	object type
string	$a_ref_id	reference id
string	$a_sub_type	sub type

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

    {
        $records = array();
        //              ilUtil::printBacktrace(10);
        //              var_dump($a_obj_type."-".$a_ref_id."-".$a_sub_type); exit;
        if ($a_sub_type == "") {
            $a_sub_type = "-";
        }
        
        $a_obj_id = ilObject::_lookupObjId($a_ref_id);
        
        // object-wide metadata configuration setting
        include_once 'Services/Container/classes/class.ilContainer.php';
        include_once 'Services/Object/classes/class.ilObjectServiceSettingsGUI.php';
        $config_setting = ilContainer::_lookupContainerSetting(
            $a_obj_id,
            ilObjectServiceSettingsGUI::CUSTOM_METADATA,
            false
        );
        
        $optional = array();
        foreach (self::_getActivatedRecordsByObjectType($a_obj_type, $a_sub_type) as $record) {
            // check scope
            if (self::isFilteredByScope($a_ref_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;
    }

References $record_id, $records, ilContainer\_lookupContainerSetting(), ilObject\_lookupObjId(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, and getObjRecSelection().

Referenced by ilGlossaryTerm\_copyTerm(), ilWikiFunctionsBlockGUI\fillDataSection(), ilPCAMDPageList\findPages(), ilAdvancedMDRecordGUI\getActiveRecords(), ilObjBookingPool\getAdvancedMDFields(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilObjectMetaDataGUI\getBlockHTML(), ilAdvancedMDValues\getInstancesForObjectId(), ilObjectMetaDataGUI\getKeyValueList(), ilObjectMetaDataGUI\hasActiveRecords(), ilObjWikiGUI\initSettingsForm(), ilAdvancedMDValues\preloadedRead(), and ilAdvancedMDValues\queryForRecords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupRecordIdByImportId()

static ilAdvancedMDRecord::_lookupRecordIdByImportId ( $a_ilias_id )

static

Lookup record Id by import id.

@access public

Parameters

string ilias id

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

    {
        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 $row->record_id;
        }
        return 0;
    }

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

Referenced by ilAdvancedMDRecordParser\extractRecordId().

Here is the caller graph for this function:

◆ _lookupTitle()

static ilAdvancedMDRecord::_lookupTitle ( $a_record_id )

static

Lookup title.

@access public

Parameters

int record_id

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

    {
        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] = $row->title;
    }

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

Referenced by ilAdvancedMDSettingsGUI\initFormSubstitutions(), ilAdvancedMDRecordGUI\parseInfoPage(), ilECSSettingsGUI\prepareFieldSelection(), and ilLuceneAdvancedSearchFields\readSections().

Here is the caller graph for this function:

◆ appendAssignedObjectType()

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

append assigned object types

@access public

Parameters

string ilias object type

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

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

◆ delete()

ilAdvancedMDRecord::delete ( )

Delete.

@access public

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

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

References _delete(), ilAdvancedMDRecordScope\deleteByRecordI(), and getRecordId().

Here is the call graph for this function:

◆ enabledScope()

ilAdvancedMDRecord::enabledScope ( )

Is scope enabled.

Returns: scope

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

    {
        return $this->scope_enabled;
    }

References $scope_enabled.

◆ enableScope()

ilAdvancedMDRecord::enableScope ( $a_stat )

Enable scope restrictions.

Parameters

bool $a_stat

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

    {
        $this->scope_enabled = $a_stat;
    }

◆ generateImportId()

ilAdvancedMDRecord::generateImportId ( )

protected

generate unique record id

@access protected

Returns

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

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

References getRecordId().

Referenced by save(), and toXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignedObjectTypes()

ilAdvancedMDRecord::getAssignedObjectTypes ( )

Get assigned object types.

@access public

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

    {
        return $this->obj_types ? $this->obj_types : array();
    }

Referenced by _clone(), isAssignedObjectType(), save(), toXML(), and update().

Here is the caller graph for this function:

◆ getDescription()

ilAdvancedMDRecord::getDescription ( )

get description

@access public

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

    {
        return $this->description;
    }

References $description.

Referenced by _clone(), save(), toXML(), and update().

Here is the caller graph for this function:

◆ getGlobalPosition()

ilAdvancedMDRecord::getGlobalPosition ( )

Returns: int

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

                                        : int
    {
        return $this->global_position;
    }

References $global_position.

Referenced by ilAdvancedMDRecordObjectOrderings\compareLocalRecords(), ilAdvancedMDRecordObjectOrderings\compareRecords(), and update().

Here is the caller graph for this function:

◆ getImportId()

ilAdvancedMDRecord::getImportId ( )

get import id

@access public

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

    {
        return $this->import_id;
    }

References $import_id.

Referenced by save().

Here is the caller graph for this function:

◆ getObjRecSelection()

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

static

Get repository object record selection.

Parameters

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

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

    {
        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[] = $rec["rec_id"];
        }
        return $recs;
    }

References $DIC, $ilDB, and $r.

Referenced by ilAdvancedMDValues\_cloneValues(), _getSelectedRecordsByObject(), ilGlossaryExporter\getActiveAdvMDRecords(), ilWikiExporter\getActiveAdvMDRecords(), ilAdvancedMDSettingsGUI\getParsedRecordObjects(), getSharedRecords(), and ilAdvancedMDRecordGUI\parseRecordSelection().

Here is the caller graph for this function:

◆ getParentObject()

ilAdvancedMDRecord::getParentObject ( )

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

    {
        return $this->parent_obj;
    }

References $parent_obj.

Referenced by _clone(), and save().

Here is the caller graph for this function:

◆ getRecordId()

ilAdvancedMDRecord::getRecordId ( )

Get record id.

@access public

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

    {
        return $this->record_id;
    }

References $record_id.

Referenced by __construct(), __destruct(), _clone(), ilAdvancedMDRecordObjectOrderings\compareLocalRecords(), delete(), generateImportId(), read(), save(), toXML(), and update().

Here is the caller graph for this function:

◆ getScopeRefIds()

ilAdvancedMDRecord::getScopeRefIds ( )

Get scope gef_ids.

Returns: type

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

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

Referenced by toXML().

Here is the caller graph for this function:

◆ getScopes()

ilAdvancedMDRecord::getScopes ( )

Get scopes.

Returns: ilAdvancedMDRecordScope[]

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

    {
        return $this->scopes;
    }

References $scopes.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getSharedRecords()

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

static

Get shared records.

Parameters

int	$a_obj1_id
int	$a_obj2_id
string	$a_sub_type

Returns: array

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

    {
        $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 ( )

get title

@access public

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

    {
        return $this->title;
    }

References $title.

Referenced by _clone(), save(), toXML(), update(), and validate().

Here is the caller graph for this function:

◆ isActive()

ilAdvancedMDRecord::isActive ( )

Check if record is active.

@access public

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

    {
        return (bool) $this->active;
    }

References $active.

Referenced by _clone(), save(), toXML(), and update().

Here is the caller graph for this function:

◆ isAssignedObjectType()

ilAdvancedMDRecord::isAssignedObjectType	(	$a_obj_type,
		$a_sub_type
	)

Is assigned object type?

Parameters

return

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

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

References $t, and getAssignedObjectTypes().

Here is the call graph for this function:

◆ isFilteredByScope()

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

static

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

Parameters

type	$a_ref_id
ilAdvancedMDRecordScope[]	$scopes

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

    {
        $tree = $GLOBALS['DIC']->repositoryTree();
        $logger = $GLOBALS['DIC']->logger()->amet();
        
        if (!count($scopes)) {
            $logger->debug('No md scope restrictions.');
            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, $scopes, $tree, and ilTree\RELATION_PARENT.

Referenced by ilAdvancedMDSettingsGUI\getParsedRecordObjects().

Here is the caller graph for this function:

◆ read()

ilAdvancedMDRecord::read ( )

private

read record and assiged object types

@access private

Parameters

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $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($row->import_id);
            $this->setActive($row->active);
            $this->setTitle($row->title);
            $this->setDescription($row->description);
            $this->setParentObject($row->parent_obj);
            $this->setGlobalPosition((int) $row->gpos);
        }
        $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" => $row->obj_type,
                "sub_type" => $row->sub_type,
                "optional" => (bool) $row->optional
            );
        }
        
        $query = 'SELECT scope_id FROM adv_md_record_scope ' .
            'WHERE record_id = ' . $ilDB->quote($this->record_id);
        $res = $ilDB->query($query);
        $this->scope_enabled = false;
        $this->scopes = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->scope_enabled = true;
            $this->scopes[] = new ilAdvancedMDRecordScope($row->scope_id);
        }
    }

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getRecordId(), setActive(), setDescription(), setGlobalPosition(), setImportId(), setParentObject(), and setTitle().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilAdvancedMDRecord::save ( )

save

@access public

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

    {
        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) " .
            "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') . " " .
            ")";
        $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, $type, generateImportId(), getAssignedObjectTypes(), getDescription(), getImportId(), getParentObject(), getRecordId(), getScopes(), getTitle(), and isActive().

Here is the call graph for this function:

◆ saveObjRecSelection()

static ilAdvancedMDRecord::saveObjRecSelection	(		$a_obj_id,
			$a_sub_type = `""`,
		array	$a_records = `null`,
			$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

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if ($a_sub_type == "") {
            $a_sub_type = "-";
        }
 
        if ((bool) $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") .
                        ")");
                }
            }
        }
    }

References $DIC, $ilDB, and $r.

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

Here is the caller graph for this function:

◆ setActive()

ilAdvancedMDRecord::setActive ( $a_active )

Set active.

@access public

Parameters

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

    {
        $this->active = $a_active;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setAssignedObjectTypes()

ilAdvancedMDRecord::setAssignedObjectTypes ( $a_obj_types )

Set assigned object types.

@access public

Parameters

array array(string) array of object types. E.g array('crs','crsl')

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

    {
        $this->obj_types = $a_obj_types;
    }

◆ setDescription()

ilAdvancedMDRecord::setDescription ( $a_description )

set description

@access public

Parameters

string description

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

    {
        $this->description = $a_description;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setGlobalPosition()

ilAdvancedMDRecord::setGlobalPosition ( int $position )

Set global position.

Parameters

int $position

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

    {
        $this->global_position = $position;
    }

Referenced by ilAdvancedMDRecordObjectOrderings\compareRecords(), and read().

Here is the caller graph for this function:

◆ setImportId()

ilAdvancedMDRecord::setImportId ( $a_id_string )

set import id

@access public

Parameters

string import id

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

    {
        $this->import_id = $a_id_string;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setParentObject()

ilAdvancedMDRecord::setParentObject ( $a_obj_id )

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

    {
        $this->parent_obj = $a_obj_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setScopes()

ilAdvancedMDRecord::setScopes ( array $a_scopes )

Set scopes.

Parameters

array $a_scopes

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

    {
        $this->scopes = $a_scopes;
    }

◆ setTitle()

ilAdvancedMDRecord::setTitle ( $a_title )

Set title.

@access public

Parameters

string title

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

    {
        $this->title = $a_title;
    }

Referenced by read().

Here is the caller graph for this function:

◆ 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.

@access public

Parameters

object ilXmlWriter

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

    {
        $writer->xmlStartTag('Record', array('active' => $this->isActive() ? 1 : 0,
            'id' => $this->generateImportId()));
        $writer->xmlElement('Title', null, $this->getTitle());
        $writer->xmlElement('Description', null, $this->getDescription());
        
        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');
        }
        
        
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($this->getRecordId()) as $definition) {
            $definition->toXML($writer);
        }
        $writer->xmlEndTag('Record');
    }

References $type, ilObject\_lookupObjId(), ilObject\_lookupType(), generateImportId(), getAssignedObjectTypes(), getDescription(), ilAdvancedMDFieldDefinition\getInstancesByRecordId(), getRecordId(), getScopeRefIds(), getTitle(), isActive(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

◆ update()

ilAdvancedMDRecord::update ( )

update

@access public

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

    {
        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') . ' ' .
            "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::deleteByRecordI($this->getRecordId());
        foreach ($this->getScopes() as $scope) {
            $scope->setRecordId($this->getRecordId());
            $scope->save();
        }
    }

References $DIC, $ilDB, $query, $res, $type, ilAdvancedMDRecordScope\deleteByRecordI(), getAssignedObjectTypes(), getDescription(), getGlobalPosition(), getRecordId(), getScopes(), getTitle(), and isActive().

Here is the call graph for this function:

◆ validate()

ilAdvancedMDRecord::validate ( )

Validate settings.

@access public

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

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

References getTitle().

Here is the call graph for this function:

Field Documentation

◆ $active

ilAdvancedMDRecord::$active

protected

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

Referenced by isActive().

◆ $db

ilAdvancedMDRecord::$db = null

protected

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

◆ $description

ilAdvancedMDRecord::$description

protected

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

Referenced by getDescription().

◆ $global_position

ilAdvancedMDRecord::$global_position

protected

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

Referenced by getGlobalPosition().

◆ $import_id

ilAdvancedMDRecord::$import_id

protected

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

Referenced by getImportId().

◆ $instances

ilAdvancedMDRecord::$instances = array()

staticprivate

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

◆ $obj_types

ilAdvancedMDRecord::$obj_types = array()

protected

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

Referenced by _getActivatedObjTypes().

◆ $parent_obj

ilAdvancedMDRecord::$parent_obj

protected

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

Referenced by getParentObject().

◆ $record_id

ilAdvancedMDRecord::$record_id

protected

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

Referenced by _getSelectedRecordsByObject(), and getRecordId().

◆ $scope_enabled

ilAdvancedMDRecord::$scope_enabled = false

protected

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

Referenced by enabledScope().

◆ $scopes

ilAdvancedMDRecord::$scopes = []

protected

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

Referenced by getScopes(), and isFilteredByScope().

◆ $title

ilAdvancedMDRecord::$title

protected

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

Referenced by getTitle().

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

Services/AdvancedMetaData/classes/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()

◆ enabledScope()

◆ enableScope()

◆ generateImportId()

◆ getAssignedObjectTypes()

◆ getDescription()

◆ getGlobalPosition()

◆ getImportId()

◆ getObjRecSelection()

◆ getParentObject()

◆ getRecordId()

◆ getScopeRefIds()

◆ getScopes()

◆ getSharedRecords()

◆ getTitle()

◆ isActive()

◆ isAssignedObjectType()

◆ isFilteredByScope()

◆ read()

◆ save()

◆ saveObjRecSelection()

◆ setActive()

◆ setAssignedObjectTypes()

◆ setDescription()

◆ setGlobalPosition()

◆ setImportId()

◆ setParentObject()

◆ setScopes()

◆ setTitle()

◆ toXML()

◆ update()

◆ validate()

Field Documentation

◆ $active

◆ $db

◆ $description

◆ $global_position

◆ $import_id

◆ $instances

◆ $obj_types

◆ $parent_obj

◆ $record_id

◆ $scope_enabled

◆ $scopes

◆ $title