ilAdvancedMDRecord Class Reference

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...
	setDefaultLanguage (string $language_code)
	getDefaultLanguage ()
	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! 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
	$language_default
	$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...

public

Parameters

int

record id

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

__destruct()

ilAdvancedMDRecord::__destruct

(

)

Destructor.

public

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

References getRecordId().

    {
        unset(self::$instances[$this->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 1029 of file class.ilAdvancedMDRecord.php.

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

    {
        $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->setDefaultLanguage($this->getDefaultLanguage());
        $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();
        }

        $record_translation = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->getRecordId());
        $record_translation->cloneRecord($new_obj->getRecordId());

        return $new_obj;
    }

Here is the call graph for this function:

_delete()

static ilAdvancedMDRecord::_delete (   $a_record_id )

static

Delete record and all related data.

public

Parameters

int

record id

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

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

Referenced by delete().

    {
        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);
    }

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

public

Parameters

string

obj types

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

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

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

    {
        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();
    }

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.

public

Parameters

string

obj_type

Returns

ilAdvancedMDRecord[]

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

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

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

    {
        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;
    }

Here is the caller graph for this function:

_getActiveSearchableRecords()

static ilAdvancedMDRecord::_getActiveSearchableRecords ( )

static

Get active searchable records.

public

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

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

    {
        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();
    }

_getAllRecordsByObjectType()

static ilAdvancedMDRecord::_getAllRecordsByObjectType ( )

static

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

Parameters

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

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

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

    {
        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;
    }

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.

public

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

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

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

    {
        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;
    }

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.

public

Parameters

int

record id

Returns

ilAdvancedMDRecord

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

Referenced by ilAdvancedMDFieldDefinitionSelect\_clone(), _getRecords(), ilAdvancedMDFieldDefinitionInteger\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\addCustomFieldToDefinitionFormInTranslationMode(), ilAdvancedMDSettingsGUI\confirmDeleteRecords(), ilAdvancedMDSettingsGUI\deleteRecords(), ilAdvancedMDSettingsGUI\exportRecords(), ilAdvancedMDRecordTableGUI\fillRow(), ilContainerFilterUtil\getContainerRecordTitle(), ilAdvancedMDFieldDefinitionSelect\import(), ilAdvancedMDFieldDefinition\importDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionSelect\importNewSelectOptions(), ilAdvancedMDRecordParser\initRecordObject(), ilAdvancedMDSettingsGUI\initRecordObject(), ilAdvancedMDRecordTranslations\read(), ilAdvancedMDFieldTranslations\read(), ilAdvancedMDSettingsGUI\updateRecords(), and ilAdvancedMDFieldDefinition\useDefaultLanguageMode().

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

Here is the caller graph for this function:

_getRecords()

static ilAdvancedMDRecord::_getRecords ( )

static

Get records.

public

Parameters

array

array of record objects

Returns

ilAdvancedMDRecord[]

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

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

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

    {
        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();
    }

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

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

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

    {
        $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;
    }

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.

public

Parameters

string

ilias id

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

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

Referenced by ilAdvancedMDRecordParser\extractRecordId().

    {
        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;
    }

Here is the caller graph for this function:

_lookupTitle()

static ilAdvancedMDRecord::_lookupTitle (   $a_record_id )

static

Lookup title.

public

Parameters

int

record_id

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

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

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

    {
        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;
    }

Here is the caller graph for this function:

appendAssignedObjectType()

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

append assigned object types

public

Parameters

string

ilias object type

Definition at line 791 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.

public

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

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

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

Here is the call graph for this function:

enabledScope()

ilAdvancedMDRecord::enabledScope

(

)

Is scope enabled.

Returns

scope

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

References $scope_enabled.

    {
        return $this->scope_enabled;
    }

enableScope()

ilAdvancedMDRecord::enableScope

(

$a_stat

)

Enable scope restrictions.

Parameters

bool

$a_stat

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

    {
        $this->scope_enabled = $a_stat;
    }

generateImportId()

ilAdvancedMDRecord::generateImportId ( )

protected

generate unique record id

protected

Returns

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

References getRecordId(), and IL_INST_ID.

Referenced by save(), and toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignedObjectTypes()

ilAdvancedMDRecord::getAssignedObjectTypes

(

)

Get assigned object types.

public

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

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

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

Here is the caller graph for this function:

getDefaultLanguage()

ilAdvancedMDRecord::getDefaultLanguage

(

)

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

References $language_default.

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

                                         :string
    {
        return (string) $this->language_default;
    }

Here is the caller graph for this function:

getDescription()

ilAdvancedMDRecord::getDescription

(

)

get description

public

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

References $description.

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

    {
        return $this->description;
    }

Here is the caller graph for this function:

getGlobalPosition()

ilAdvancedMDRecord::getGlobalPosition

(

)

Returns

int

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

References $global_position.

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

                                        : int
    {
        return $this->global_position;
    }

Here is the caller graph for this function:

getImportId()

ilAdvancedMDRecord::getImportId

(

)

get import id

public

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

References $import_id.

Referenced by save().

    {
        return $this->import_id;
    }

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

References $DIC, and $ilDB.

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

    {
        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;
    }

Here is the caller graph for this function:

getParentObject()

ilAdvancedMDRecord::getParentObject

(

)

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

References $parent_obj.

Referenced by _clone(), and save().

    {
        return $this->parent_obj;
    }

Here is the caller graph for this function:

getRecordId()

ilAdvancedMDRecord::getRecordId

(

)

Get record id.

public

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

References $record_id.

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

    {
        return $this->record_id;
    }

Here is the caller graph for this function:

getScopeRefIds()

ilAdvancedMDRecord::getScopeRefIds

(

)

Get scope gef_ids.

Returns

type

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

Referenced by toXML().

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

Here is the caller graph for this function:

getScopes()

ilAdvancedMDRecord::getScopes

(

)

Get scopes.

Returns

ilAdvancedMDRecordScope[]

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

References $scopes.

Referenced by save(), and update().

    {
        return $this->scopes;
    }

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

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

    {
        $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;
    }

Here is the call graph for this function:

getTitle()

ilAdvancedMDRecord::getTitle

(

)

get title

public

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

References $title.

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

    {
        return $this->title;
    }

Here is the caller graph for this function:

isActive()

ilAdvancedMDRecord::isActive

(

)

Check if record is active.

public

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

References $active.

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

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

Here is the caller graph for this function:

isAssignedObjectType()

ilAdvancedMDRecord::isAssignedObjectType	(		$a_obj_type,
			$a_sub_type
	)

Is assigned object type?

Parameters

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

References getAssignedObjectTypes().

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

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

References $GLOBALS, and ilTree\RELATION_PARENT.

Referenced by ilAdvancedMDSettingsGUI\getParsedRecordObjects().

    {
        $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;
    }

Here is the caller graph for this function:

read()

ilAdvancedMDRecord::read ( )

private

read record and assiged object types

private

Parameters

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

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

Referenced by __construct().

    {
        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);
            $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" => $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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilAdvancedMDRecord::save

(

)

save

public

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

References $DIC, $ilDB, $query, $res, $type, generateImportId(), getAssignedObjectTypes(), getDefaultLanguage(), getDescription(), getImportId(), getParentObject(), getRecordId(), getScopes(), getTitle(), isActive(), and ilDBConstants\T_TEXT.

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

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

References $DIC, and $ilDB.

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

    {
        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") .
                        ")");
                }
            }
        }
    }

Here is the caller graph for this function:

setActive()

ilAdvancedMDRecord::setActive

(

$a_active

)

Set active.

public

Parameters

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

Referenced by read().

    {
        $this->active = $a_active;
    }

Here is the caller graph for this function:

setAssignedObjectTypes()

ilAdvancedMDRecord::setAssignedObjectTypes

(

$a_obj_types

)

Set assigned object types.

public

Parameters

array

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

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

    {
        $this->obj_types = $a_obj_types;
    }

setDefaultLanguage()

ilAdvancedMDRecord::setDefaultLanguage

(

string

$language_code

)

Parameters

string

$language_code

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

Referenced by read().

    {
        $this->language_default = $language_code;
    }

Here is the caller graph for this function:

setDescription()

ilAdvancedMDRecord::setDescription

(

$a_description

)

set description

public

Parameters

string

description

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

Referenced by read().

    {
        $this->description = $a_description;
    }

Here is the caller graph for this function:

setGlobalPosition()

ilAdvancedMDRecord::setGlobalPosition

(

int

$position

)

Set global position.

Parameters

int

$position

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

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

    {
        $this->global_position = $position;
    }

Here is the caller graph for this function:

setImportId()

ilAdvancedMDRecord::setImportId

(

$a_id_string

)

set import id

public

Parameters

string

import id

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

Referenced by read().

    {
        $this->import_id = $a_id_string;
    }

Here is the caller graph for this function:

setParentObject()

ilAdvancedMDRecord::setParentObject

(

$a_obj_id

)

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

Referenced by read().

    {
        $this->parent_obj = $a_obj_id;
    }

Here is the caller graph for this function:

setScopes()

ilAdvancedMDRecord::setScopes

(

array

$a_scopes

)

Set scopes.

Parameters

array

$a_scopes

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

    {
        $this->scopes = $a_scopes;
    }

setTitle()

ilAdvancedMDRecord::setTitle

(

$a_title

)

Set title.

public

Parameters

string

title

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

Referenced by read().

    {
        $this->title = $a_title;
    }

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.

public

Parameters

object

ilXmlWriter

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

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

    {
        $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');
        }
        
        
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($this->getRecordId()) as $definition) {
            $definition->toXML($writer);
        }
        $writer->xmlEndTag('Record');
    }

Here is the call graph for this function:

update()

ilAdvancedMDRecord::update

(

)

update

public

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

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

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

Here is the call graph for this function:

validate()

ilAdvancedMDRecord::validate

(

)

Validate settings.

public

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

References getTitle().

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

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

$language_default

ilAdvancedMDRecord::$language_default

protected

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

Referenced by getDefaultLanguage().

$obj_types

ilAdvancedMDRecord::$obj_types = array()

protected

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

Referenced by _getActivatedObjTypes().

$parent_obj

ilAdvancedMDRecord::$parent_obj

protected

Definition at line 38 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 39 of file class.ilAdvancedMDRecord.php.

Referenced by enabledScope().

$scopes

ilAdvancedMDRecord::$scopes = []

protected

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

Referenced by getScopes().

$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