ilAdvancedMDFieldDefinitionSelect Class Reference

AMD field type select. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionSelect:

Collaboration diagram for ilAdvancedMDFieldDefinitionSelect:

Public Member Functions
	getType ()
	getSearchQueryParserValue (ilADTSearchBridge $search_bridge)
	setOptions (array $a_values=null)
	Set options. More...
	getOptions ()
	Get options. More...
	getOptionTranslations ()
	getOptionTranslation (string $language)
	setOptionTranslations (array $translations)
	setOptionTranslationsForLanguage (array $translations, string $language)
	getFieldDefinitionForTableGUI (string $content_language)
	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
	Import custom post values from definition form. More...
	importDefinitionFormPostValuesNeedsConfirmation ()
	prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
	delete ()
	save ($a_keep_pos=false)
	update ()
	importXMLProperty ($a_key, $a_value)
	getValueForXML (ilADT $element)
	importValueFromXML ($a_cdata)
	prepareElementForEditor (ilADTFormBridge $a_enum)
	_clone ($a_new_record_id)
Public Member Functions inherited from ilAdvancedMDFieldDefinition
	__construct ($a_field_id=null, string $language='')
	Constructor. More...
	getType ()
	Get type. More...
	useDefaultLanguageMode (string $language)
	Check if default language mode has to be used: no language given or language equals default language. More...
	getTypeTitle ()
	Get type title (lang id) More...
	getADTDefinition ()
	Get ADT definition instance. More...
	getADT ()
	Get ADT instance. More...
	getFieldId ()
	Get field_id. More...
	setRecordId ($a_id)
	Set record id. More...
	getRecordId ()
	Get record id. More...
	setImportId ($a_id_string)
	Set import id. More...
	getImportId ()
	Get import id. More...
	setPosition ($a_pos)
	Set position. More...
	getPosition ()
	Get position. More...
	setTitle ($a_title)
	Get title. More...
	getTitle ()
	Get title. More...
	setDescription ($a_desc)
	Set description. More...
	getDescription ()
	Get description. More...
	isSearchSupported ()
	Is search supported at all. More...
	isFilterSupported ()
	Is search by filter supported. More...
	setSearchable ($a_status)
	Toggle searchable. More...
	isSearchable ()
	Is searchable. More...
	setRequired ($a_status)
	Toggle required. More...
	isRequired ()
	Is required field. More...
	getFieldDefinitionForTableGUI (string $content_language)
	Parse properties for table gui. More...
	addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $language='')
	Add input elements to definition form. More...
	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
	Import custom post values from definition form. More...
	importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $active_language)
	Import post values from definition form. More...
	importDefinitionFormPostValuesNeedsConfirmation ()
	prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
	prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
	generateImportId ($a_field_id)
	Generate unique record id. More...
	save ($a_keep_pos=false)
	Create new field entry. More...
	update ()
	Update field entry. More...
	delete ()
	Delete field entry. More...
	toXML (ilXmlWriter $a_writer)
	To Xml. More...
	importXMLProperty ($a_key, $a_value)
	Import property from XML. More...
	getValueForXML (ilADT $element)
	Parse ADT value for xml (export) More...
	importValueFromXML ($a_cdata)
	Import value from xml. More...
	importFromECS ($a_ecs_type, $a_value, $a_sub_id)
	Import meta data from ECS. More...
	prepareElementForEditor (ilADTFormBridge $a_bridge)
	Prepare editor form elements. More...
	getSearchQueryParserValue (ilADTSearchBridge $a_adt_search)
	Get value for search query parser. More...
	getSearchValueSerialized (ilADTSearchBridge $a_adt_search)
	Get value for search persistence. More...
	setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)
	Set value from search persistence. More...
	searchSubObjects (ilADTSearchBridge $a_adt_search, $a_obj_id, $sub_obj_type)
	searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, $a_locate, $a_search_type)
	Search objects. More...
	getLuceneSearchString ($a_value)
	Get search string in lucene syntax. More...
	prepareElementForSearch (ilADTSearchBridge $a_bridge)
	Prepare search form elements. More...
	_clone ($a_new_record_id)
	Clone field definition. More...
	hasComplexOptions ()
	getComplexOptionsOverview ($a_parent_gui, string $parent_cmd)

Data Fields
const	REMOVE_ACTION_ID = "-iladvmdrm-"
Data Fields inherited from ilAdvancedMDFieldDefinition
const	TYPE_SELECT = 1
const	TYPE_TEXT = 2
const	TYPE_DATE = 3
const	TYPE_DATETIME = 4
const	TYPE_INTEGER = 5
const	TYPE_FLOAT = 6
const	TYPE_LOCATION = 7
const	TYPE_SELECT_MULTI = 8
const	TYPE_ADDRESS = 99
const	TYPE_EXTERNAL_LINK = 9
const	TYPE_INTERNAL_LINK = 10

Protected Member Functions
	initADTDefinition ()
	importFieldDefinition (array $a_def)
	getFieldDefinition ()
	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false, string $language='')
	Add input elements to definition form. More...
	addCustomFieldToDefinitionFormInTranslationMode (ilPropertyFormGUI $form, bool $disabled, string $language='')
	buildConfirmedObjects (ilPropertyFormGUI $a_form)
	Process custom post values from definition form. More...
	importNewSelectOptions (bool $multi, ilPropertyFormGUI $a_form, string $language='')
	findBySingleValue (ilADTEnumSearchBridgeMulti $a_search, $a_value)
	importTranslatedFormPostValues (ilPropertyFormGUI $form, string $language)
	deleteOptionTranslations ()
	updateOptionTranslations ()
	saveOptionTranslations ()
	addPropertiesToXML (ilXmlWriter $a_writer)
	import (array $db_data)
Protected Member Functions inherited from ilAdvancedMDFieldDefinition
	init ()
	Init properties. More...
	initADTDefinition ()
	Init adt instance. More...
	setADT (ilADT $a_adt)
	Set ADT instance. More...
	setFieldId ($a_id)
	Set field_id. More...
	importFieldDefinition (array $a_def)
	Import (type-specific) field definition from DB. More...
	getFieldDefinition ()
	Get (type-specific) field definition. More...
	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false, string $language='')
	Add custom input elements to definition form. More...
	getLastPosition ()
	Get last position of record. More...
	getDBProperties ()
	Get all definition properties for DB. More...
	import (array $a_data)
	Import from DB. More...
	read ($a_field_id)
	Read field definition. More...
	addPropertiesToXML (ilXmlWriter $a_writer)
	Add (type-specific) properties to xml export. More...
	parseSearchObjects (array $a_records, array $a_object_types)
	Add object-data needed for global search to AMD search results. More...

Protected Attributes
	$options = []
	$confirm_objects = []
	$confirm_objects_values = []
	$confirmed_objects
	$option_translations = []
Protected Attributes inherited from ilAdvancedMDFieldDefinition
	$field_id
	$record_id
	$import_id
	$position
	$title
	$description
	$searchable
	$required
	$adt_def
	$adt
	$language = ''
	$logger

Additional Inherited Members
Static Public Member Functions inherited from ilAdvancedMDFieldDefinition
static	getInstance ($a_field_id, $a_type=null, string $language='')
	Get definition instance by type. More...
static	exists ($a_field_id)
	Check if field exists. More...
static	getInstanceByTypeString ($a_type)
	Get instance by type string (used by import) More...
static	getInstancesByRecordId ($a_record_id, $a_only_searchable=false, string $language='')
	Get definitions by record id. More...
static	getInstancesByObjType ($a_obj_type, $a_active_only=true)
static	getInstanceByImportId ($a_import_id)
	Get definition instance by import id. More...
static	getSearchableDefinitionIds ()
	Get searchable definition ids (performance is key) More...
static	getADTGroupForDefinitions (array $a_defs)
	Init ADTGroup for definitions. More...
static	getValidTypes ()
	Get all valid types. More...
static	isValidType ($a_type)
	Is given type valid. More...
Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static	getTypeString ($a_type)
	Get type string. More...

Detailed Description

AMD field type select.

Author

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

Version

$Id$

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

Member Function Documentation

_clone()

ilAdvancedMDFieldDefinitionSelect::_clone

(

$a_new_record_id

)

Parameters

int

$a_new_record_id

Returns

ilAdvancedMDFieldDefinition

Definition at line 752 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $DIC, $options, $query, $res, ilAdvancedMDRecord\_getInstanceByRecordId(), ilDBConstants\FETCHMODE_OBJECT, ilAdvancedMDFieldDefinition\getFieldId(), ilAdvancedMDFieldDefinition\getRecordId(), and ilDBConstants\T_INTEGER.

    {
        global $DIC;

        $db = $DIC->database();

        $obj = parent::_clone($a_new_record_id);
        $query = 'select * from adv_mdf_enum ' .
            'where field_id = ' . $db->quote($this->getFieldId(), ilDBConstants::T_INTEGER) . ' ' .
            'order by idx';
        $res = $db->query($query);
        $options = [];
        $default = [];
        $record = ilAdvancedMDRecord::_getInstanceByRecordId($this->getRecordId());
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($row->lang_code == $record->getDefaultLanguage()) {
                $default[$row->idx] = $row->value;
            }
            $options[$row->lang_code][$row->idx] = $row->value;
        }
        $obj->setOptions($default);
        $obj->setOptionTranslations($options);
        $obj->update();
        return $obj;
    }

Here is the call graph for this function:

addCustomFieldToDefinitionForm()

ilAdvancedMDFieldDefinitionSelect::addCustomFieldToDefinitionForm ( ilPropertyFormGUI  $a_form,   $a_disabled = false, string  $language = ''  )

protected

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled
string	$language

Exceptions

ilFormException

Definition at line 169 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $DIC, ilAdvancedMDFieldDefinition\$language, $lng, $options, addCustomFieldToDefinitionFormInTranslationMode(), ilPropertyFormGUI\addItem(), getOptions(), and ilAdvancedMDFieldDefinition\useDefaultLanguageMode().

    {
        global $DIC;

        $lng = $DIC['lng'];

        if (!$this->useDefaultLanguageMode($language)) {
            return $this->addCustomFieldToDefinitionFormInTranslationMode($a_form, $a_disabled, $language);
        }

        // if not the default language is chosen => no add/remove; no sorting
        $field = new ilTextInputGUI($lng->txt("meta_advmd_select_options"), "opts");
        $field->setRequired(true);
        $field->setMulti(true, true);
        $field->setMaxLength(255); // :TODO:
        $a_form->addItem($field);
        
        $options = $this->getOptions();
        if ($options) {
            $field->setMultiValues($options);
            $field->setValue(array_shift($options));
        }
        
        if ($a_disabled) {
            $field->setDisabled(true);
        }
    }

Here is the call graph for this function:

addCustomFieldToDefinitionFormInTranslationMode()

ilAdvancedMDFieldDefinitionSelect::addCustomFieldToDefinitionFormInTranslationMode ( ilPropertyFormGUI  $form, bool  $disabled, string  $language = ''  )

protected

Parameters

ilPropertyFormGUI	$form
bool	$disabled
string	$language

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

References $DIC, $index, ilAdvancedMDFieldDefinition\$language, $lng, ilAdvancedMDFieldDefinition\$title, ilAdvancedMDRecord\_getInstanceByRecordId(), ilPropertyFormGUI\addItem(), getOptions(), and getOptionTranslation().

Referenced by addCustomFieldToDefinitionForm().

    {
        global $DIC;

        $lng = $DIC->language();

        $default_language = ilAdvancedMDRecord::_getInstanceByRecordId($this->record_id)->getDefaultLanguage();

        $translation = $this->getOptionTranslation($language);

        $first = true;
        foreach ($this->getOptions() as $index => $option) {
            $title = '';
            if ($first) {
                $title = $lng->txt("meta_advmd_select_options");
            }
            $text = new ilTextInputGUI($title, 'opts__' . $language . '__' . (string) $index);
            if (isset($translation[$index])) {
                $text->setValue($translation[$index]);
            };
            $text->setInfo($default_language . ': ' . $option);
            $text->setMaxLength(255);
            $text->setRequired(true);

            $first = false;
            $form->addItem($text);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addPropertiesToXML()

ilAdvancedMDFieldDefinitionSelect::addPropertiesToXML ( ilXmlWriter  $a_writer )

protected

Definition at line 672 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References getOptions(), getOptionTranslations(), and ilXmlWriter\xmlElement().

    {
        foreach ($this->getOptions() as $value) {
            $a_writer->xmlElement('FieldValue', null, $value);
        }
        foreach ($this->getOptionTranslations() as $lang_key => $translations) {
            foreach ((array) $translations as $value) {
                $a_writer->xmlElement('FieldValue', ['id' => $lang_key], $value);
            }
        }
    }

Here is the call graph for this function:

buildConfirmedObjects()

ilAdvancedMDFieldDefinitionSelect::buildConfirmedObjects ( ilPropertyFormGUI  $a_form )

protected

Process custom post values from definition form.

Parameters

ilPropertyFormGUI

$a_form

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

References $res, ilAdvancedMDFieldDefinition\getFieldId(), and ilPropertyFormGUI\getInput().

Referenced by importNewSelectOptions().

    {
        // #15719
        $recipes = $a_form->getInput("conf_det");
        if (is_array($recipes[$this->getFieldId()])) {
            $recipes = $recipes[$this->getFieldId()];
            $sum = $a_form->getInput("conf_det_act");
            $sum = $sum[$this->getFieldId()];
            $sgl = $a_form->getInput("conf");
            $sgl = $sgl[$this->getFieldId()];
                        
            $res = array();
            foreach ($recipes as $old_option => $recipe) {
                $sum_act = $sum[$old_option];
                $sgl_act = $sgl[$old_option];
                
                if ($recipe == "sum") {
                    // #18885
                    if (!$sum_act) {
                        return;
                    }
                    
                    foreach (array_keys($sgl_act) as $obj_idx) {
                        if ($sum_act == self::REMOVE_ACTION_ID) {
                            $sum_act = "";
                        }
                        if (substr($sum_act, 0, 4) == 'idx_') {
                            $parts = explode('_', $sum_act);
                            $sum_act = $parts[1];
                        }
                        $res[$old_option][$obj_idx] = $sum_act;
                    }
                } else {
                    // #18885
                    foreach ($sgl_act as $sgl_index => $sgl_item) {
                        if (!$sgl_item) {
                            return;
                        } elseif ($sgl_item == self::REMOVE_ACTION_ID) {
                            $sgl_act[$sgl_index] = "";
                        }
                        if (substr($sgl_item, 0, 4) == 'idx_') {
                            $parts = explode('_', $sgl_item);
                            $sgl_act[$sgl_index] = $parts[1];
                        }
                    }
                    
                    $res[$old_option] = $sgl_act;
                }
            }
            return $res;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilAdvancedMDFieldDefinitionSelect::delete

(

)

Definition at line 522 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References deleteOptionTranslations().

    {
        $this->deleteOptionTranslations();
        parent::delete();
    }

Here is the call graph for this function:

deleteOptionTranslations()

ilAdvancedMDFieldDefinitionSelect::deleteOptionTranslations ( )

protected

Definition at line 537 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $DIC, $query, ilAdvancedMDFieldDefinition\getFieldId(), and ilDBConstants\T_INTEGER.

Referenced by delete(), and updateOptionTranslations().

    {
        global $DIC;

        $db = $DIC->database();
        $query = 'delete from adv_mdf_enum ' .
            'where field_id = ' . $db->quote($this->getFieldId(), ilDBConstants::T_INTEGER);
        $db->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findBySingleValue()

ilAdvancedMDFieldDefinitionSelect::findBySingleValue ( ilADTEnumSearchBridgeMulti  $a_search,   $a_value  )

protected

Definition at line 369 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $res, ilADTActiveRecordByType\find(), ilADTSearchBridgeSingle\getADT(), ilAdvancedMDFieldDefinition\getFieldId(), and ilADTEnumSearchBridgeMulti\getSQLCondition().

Referenced by importNewSelectOptions(), and update().

    {
        $res = array();
        $a_search->getADT()->setSelections((array) $a_value);
        $condition = $a_search->getSQLCondition('value_index');

        $in_use = ilADTActiveRecordByType::find(
            "adv_md_values",
            "Enum",
            $this->getFieldId(),
            $condition
        );
        if ($in_use) {
            foreach ($in_use as $item) {
                $res[] = array($item["obj_id"], $item["sub_type"], $item["sub_id"], $item["value_index"]);
            }
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldDefinition()

ilAdvancedMDFieldDefinitionSelect::getFieldDefinition ( )

protected

Returns

array

Definition at line 141 of file class.ilAdvancedMDFieldDefinitionSelect.php.

    {
        return [];
    }

getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionSelect::getFieldDefinitionForTableGUI

(

string

$content_language

)

Definition at line 146 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $DIC, $lng, $options, getOptions(), and getOptionTranslation().

    {
        global $DIC;

        $lng = $DIC['lng'];

        if (strlen($content_language)) {
            $options = $this->getOptionTranslation($content_language);
        } else {
            $options = $this->getOptions();
        }
        return [
            $lng->txt("meta_advmd_select_options") => implode(",", $options)
        ];
    }

Here is the call graph for this function:

getOptions()

ilAdvancedMDFieldDefinitionSelect::getOptions

(

)

Get options.

Returns

array

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

References $options.

Referenced by addCustomFieldToDefinitionForm(), addCustomFieldToDefinitionFormInTranslationMode(), addPropertiesToXML(), getFieldDefinitionForTableGUI(), importTranslatedFormPostValues(), ilAdvancedMDFieldDefinitionSelectMulti\initADTDefinition(), and initADTDefinition().

    {
        return $this->options;
    }

Here is the caller graph for this function:

getOptionTranslation()

ilAdvancedMDFieldDefinitionSelect::getOptionTranslation

(

string

$language

)

Parameters

string

$language

Definition at line 104 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References ilAdvancedMDFieldDefinition\$language, and getOptionTranslations().

Referenced by addCustomFieldToDefinitionFormInTranslationMode(), getFieldDefinitionForTableGUI(), and importNewSelectOptions().

    {
        if (isset($this->getOptionTranslations()[$language])) {
            return $this->getOptionTranslations()[$language];
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOptionTranslations()

ilAdvancedMDFieldDefinitionSelect::getOptionTranslations

(

)

Definition at line 96 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $option_translations.

Referenced by addPropertiesToXML(), getOptionTranslation(), importNewSelectOptions(), importTranslatedFormPostValues(), ilAdvancedMDFieldDefinitionSelectMulti\initADTDefinition(), initADTDefinition(), and saveOptionTranslations().

    {
        return $this->option_translations;
    }

Here is the caller graph for this function:

getSearchQueryParserValue()

ilAdvancedMDFieldDefinitionSelect::getSearchQueryParserValue

(

ilADTSearchBridge

$search_bridge

)

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

    {
        return $search_bridge->getADT()->getSelection();
    }

getType()

ilAdvancedMDFieldDefinitionSelect::getType

(

)

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

    {
        return self::TYPE_SELECT;
    }

getValueForXML()

ilAdvancedMDFieldDefinitionSelect::getValueForXML

(

ilADT

$element

)

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

    {
        return $element->getSelection();
    }

import()

ilAdvancedMDFieldDefinitionSelect::import ( array  $db_data )

protected

Definition at line 724 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $DIC, $options, $query, $res, ilAdvancedMDRecord\_getInstanceByRecordId(), ilDBConstants\FETCHMODE_OBJECT, ilAdvancedMDFieldDefinition\getFieldId(), ilAdvancedMDFieldDefinition\getRecordId(), setOptions(), setOptionTranslations(), and ilDBConstants\T_INTEGER.

    {
        global $DIC;

        parent::import($db_data);

        $db = $DIC->database();
        $query = 'select * from adv_mdf_enum ' .
            'where field_id = ' . $db->quote($this->getFieldId(), ilDBConstants::T_INTEGER) . ' ' .
            'order by idx';
        $res = $db->query($query);
        $options = [];
        $default = [];
        $record = ilAdvancedMDRecord::_getInstanceByRecordId($this->getRecordId());
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($row->lang_code == $record->getDefaultLanguage()) {
                $default[$row->idx] = $row->value;
            }
            $options[$row->lang_code][$row->idx] = $row->value;
        }
        $this->setOptions($default);
        $this->setOptionTranslations($options);
    }

Here is the call graph for this function:

importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionSelect::importCustomDefinitionFormPostValues	(	ilPropertyFormGUI	$a_form,
		string	$language = ''
	)

Import custom post values from definition form.

Parameters

ilPropertyFormGUI	$a_form
string	$language

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

References ilAdvancedMDFieldDefinition\$language, and importNewSelectOptions().

    {
        $this->importNewSelectOptions(true, $a_form, $language);
    }

Here is the call graph for this function:

importDefinitionFormPostValuesNeedsConfirmation()

ilAdvancedMDFieldDefinitionSelect::importDefinitionFormPostValuesNeedsConfirmation

(

)

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

    {
        return is_array($this->confirm_objects) && count($this->confirm_objects) > 0;
    }

importFieldDefinition()

ilAdvancedMDFieldDefinitionSelect::importFieldDefinition ( array  $a_def )

protected

Parameters

array

$a_def

Definition at line 132 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References setOptions().

    {
        // options (field_values from adv_mdf_field_definitions are not used)
        $this->setOptions([]);
    }

Here is the call graph for this function:

importNewSelectOptions()

ilAdvancedMDFieldDefinitionSelect::importNewSelectOptions ( bool  $multi, ilPropertyFormGUI  $a_form, string  $language = ''  )

protected

Definition at line 299 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References ilAdvancedMDFieldDefinition\$language, $options, ilAdvancedMDRecord\_getInstanceByRecordId(), buildConfirmedObjects(), findBySingleValue(), ilAdvancedMDFieldDefinition\getADTDefinition(), ilPropertyFormGUI\getInput(), ilADTFactory\getInstance(), getOptionTranslation(), getOptionTranslations(), ilAdvancedMDFieldDefinition\getRecordId(), importTranslatedFormPostValues(), setOptionTranslationsForLanguage(), and ilAdvancedMDFieldDefinition\useDefaultLanguageMode().

Referenced by ilAdvancedMDFieldDefinitionSelectMulti\importCustomDefinitionFormPostValues(), and importCustomDefinitionFormPostValues().

      : void {
        if (!$this->useDefaultLanguageMode($language)) {
            $this->importTranslatedFormPostValues($a_form, $language);
            return;
        }

        if (!strlen($language)) {
            $language = ilAdvancedMDRecord::_getInstanceByRecordId($this->getRecordId())->getDefaultLanguage();
        }

        $old = $this->getOptionTranslation($language);
        $new = $a_form->getInput("opts");

        $missing = array_diff_assoc($old, $new);
        // keep track of the indices of entries persisting through the operation
        $index_map = [];
        foreach ($missing as $missing_idx => $missing_value) {
            if (in_array($missing_value, $new)) {
                $index_map[$missing_idx] = array_search($missing_value, $new);
            }
        }

        if (sizeof($missing)) {
            $this->confirmed_objects = $this->buildConfirmedObjects($a_form);
            $already_confirmed = is_array($this->confirmed_objects);

            $search = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($this->getADTDefinition(), false, $multi);
            foreach ($missing as $missing_idx => $missing_value) {
                $in_use = $this->findBySingleValue($search, $missing_idx);
                if (is_array($in_use)) {
                    foreach ($in_use as $item) {
                        if (array_key_exists($missing_idx, $index_map)) {
                            $complete_id = $item[0] . "_" . $item[1] . "_" . $item[2];
                            $new_index = $index_map[$missing_idx];
                            $this->confirmed_objects[$missing_idx][$complete_id] = $new_index;
                            continue;
                        }
                        if (!$already_confirmed) {
                            $this->confirm_objects[$missing_idx][] = $item;
                            $this->confirm_objects_values[$missing_idx] = $old[$missing_idx];
                        }
                    }
                }
            }
        }
        $this->old_options = $old;

        // update the options along with their translations
        $this->setOptionTranslationsForLanguage($new, $language);
        foreach ($this->getOptionTranslations() as $current_lang => $options) {
            $current_lang = (string) $current_lang;
            if ($current_lang === $language) {
                continue;
            }
            $updated_translations = [];
            foreach ($options as $idx => $option) {
                if (array_key_exists($idx, $index_map)) {
                    $updated_translations[$index_map[$idx]] = $option;
                    continue;
                }
                $updated_translations[$idx] = $option;
            }
            $this->setOptionTranslationsForLanguage($updated_translations, $current_lang);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importTranslatedFormPostValues()

ilAdvancedMDFieldDefinitionSelect::importTranslatedFormPostValues ( ilPropertyFormGUI  $form, string  $language  )

protected

Parameters

ilPropertyFormGUI	$form
string	$language

Definition at line 395 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References ilAdvancedMDFieldDefinition\$language, ilPropertyFormGUI\getInput(), getOptions(), getOptionTranslations(), and setOptionTranslations().

Referenced by importNewSelectOptions().

    {
        $translated_options = [];
        foreach ($this->getOptions() as $idx => $value) {
            $value = $form->getInput('opts__' . $language . '__' . (string) $idx);
            $translated_options[] = trim($value);
        }
        $translations = $this->getOptionTranslations();
        $translations[$language] = $translated_options;
        $this->setOptionTranslations($translations);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importValueFromXML()

ilAdvancedMDFieldDefinitionSelect::importValueFromXML

(

$a_cdata

)

Definition at line 707 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References ilAdvancedMDFieldDefinition\getADT().

    {
        $this->getADT()->setSelection($a_cdata);
    }

Here is the call graph for this function:

importXMLProperty()

ilAdvancedMDFieldDefinitionSelect::importXMLProperty	(		$a_key,
			$a_value
	)

Parameters

string	$a_key
string	$a_value

Definition at line 688 of file class.ilAdvancedMDFieldDefinitionSelect.php.

    {
        if (!$a_key) {
            $this->options[] = $a_value;
        } else {
            $this->option_translations[$a_key][] = $a_value;
        }
    }

initADTDefinition()

ilAdvancedMDFieldDefinitionSelect::initADTDefinition ( )

protected

Definition at line 47 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References ilAdvancedMDFieldDefinition\$language, $options, ilADTFactory\getInstance(), getOptions(), getOptionTranslations(), and language().

    {
        $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Enum");
        $def->setNumeric(false);

        $options = $this->getOptions();
        $translated_options = [];
        if (isset($this->getOptionTranslations()[$this->language])) {
            $translated_options = $this->getOptionTranslations()[$this->language];
        }
        $def->setOptions(array_replace($options, $translated_options));
        return $def;
    }

Here is the call graph for this function:

prepareCustomDefinitionFormConfirmation()

ilAdvancedMDFieldDefinitionSelect::prepareCustomDefinitionFormConfirmation

(

ilPropertyFormGUI

$a_form

)

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

References $_POST, $DIC, $lng, $options, ilAdvancedMDFieldDefinition\$title, $type, ilObject\_lookupTitle(), ilObject\_lookupType(), ilPropertyFormGUI\addItem(), ilAdvancedMDFieldDefinition\getFieldId(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilUtil\sendFailure(), and ilFormPropertyGUI\setRequired().

    {
        global $DIC;

        $lng = $DIC['lng'];
        $objDefinition = $DIC['objDefinition'];
                
        $a_form->getItemByPostVar("opts")->setDisabled(true);
        if (is_array($this->confirm_objects) && count($this->confirm_objects) > 0) {
            $new_options = $a_form->getInput("opts");
            
            $sec = new ilFormSectionHeaderGUI();
            $sec->setTitle($lng->txt("md_adv_confirm_definition_select_section"));
            $a_form->addItem($sec);
                                    
            foreach ($this->confirm_objects as $old_option => $items) {
                $old_option_value = $this->confirm_objects_values[$old_option];
                $details = new ilRadioGroupInputGUI($lng->txt("md_adv_confirm_definition_select_option") . ': "' . $old_option_value . '"', "conf_det[" . $this->getFieldId() . "][" . $old_option . "]");
                $details->setRequired(true);
                $details->setValue("sum");
                $a_form->addItem($details);
                                
                // automatic reload does not work
                if (isset($_POST["conf_det"][$this->getFieldId()][$old_option])) {
                    $details->setValue($_POST["conf_det"][$this->getFieldId()][$old_option]);
                }
                
                $sum = new ilRadioOption($lng->txt("md_adv_confirm_definition_select_option_all"), "sum");
                $details->addOption($sum);
                
                $sel = new ilSelectInputGUI(
                    $lng->txt("md_adv_confirm_definition_select_option_all_action"),
                    "conf_det_act[" . $this->getFieldId() . "][" . $old_option . "]"
                );
                $sel->setRequired(true);
                $options = array(
                    "" => $lng->txt("please_select"),
                    self::REMOVE_ACTION_ID => $lng->txt("md_adv_confirm_definition_select_option_remove")
                );
                foreach ($new_options as $new_option_index => $new_option) {
                    $options['idx_' . $new_option_index] = $lng->txt("md_adv_confirm_definition_select_option_overwrite") . ': "' . $new_option . '"';
                }
                $sel->setOptions($options);
                $sum->addSubItem($sel);
                
                // automatic reload does not work
                if (isset($_POST["conf_det_act"][$this->getFieldId()][$old_option])) {
                    if ($_POST["conf_det_act"][$this->getFieldId()][$old_option]) {
                        $sel->setValue($_POST["conf_det_act"][$this->getFieldId()][$old_option]);
                    } elseif ($_POST["conf_det"][$this->getFieldId()][$old_option] == "sum") {
                        $sel->setAlert($lng->txt("msg_input_is_required"));
                        ilUtil::sendFailure($lng->txt("form_input_not_valid"));
                    }
                }
                $single = new ilRadioOption($lng->txt("md_adv_confirm_definition_select_option_single"), "sgl");
                $details->addOption($single);
                foreach ($items as $item) {
                    $obj_id = $item[0];
                    $sub_type = $item[1];
                    $sub_id = $item[2];
                    
                    $item_id = $obj_id . "_" . $sub_type . "_" . $sub_id;
                    
                    $type = ilObject::_lookupType($obj_id);
                    $type_title = $lng->txt("obj_" . $type);
                    $title = ' "' . ilObject::_lookupTitle($obj_id) . '"';
                    
                    if ($sub_id) {
                        $class = "ilObj" . $objDefinition->getClassName($type);
                        $class_path = $objDefinition->getLocation($type);
                        include_once $class_path . "/class." . $class . ".php";
                        $ints = class_implements($class);
                        if (isset($ints["ilAdvancedMetaDataSubItems"])) {
                            $sub_title = $class::getAdvMDSubItemTitle($obj_id, $sub_type, $sub_id);
                            if ($sub_title) {
                                $title .= ' (' . $sub_title . ')';
                            }
                        }
                    }
                    
                    $sel = new ilSelectInputGUI(
                        $type_title . ' ' . $title,
                        "conf[" . $this->getFieldId() . "][" . $old_option . "][" . $item_id . "]"
                    );
                    $sel->setRequired(true);
                    $options = array(
                        "" => $lng->txt("please_select"),
                        self::REMOVE_ACTION_ID => $lng->txt("md_adv_confirm_definition_select_option_remove")
                    );
                    foreach ($new_options as $new_option_index => $new_option) {
                        $options['idx_' . $new_option_index] = $lng->txt("md_adv_confirm_definition_select_option_overwrite") . ': "' . $new_option . '"';
                    }
                    $sel->setOptions($options);
                    
                    // automatic reload does not work
                    if (isset($_POST["conf"][$this->getFieldId()][$old_option][$item_id])) {
                        if ($_POST["conf"][$this->getFieldId()][$old_option][$item_id]) {
                            $sel->setValue($_POST["conf"][$this->getFieldId()][$old_option][$item_id]);
                        } elseif ($_POST["conf_det"][$this->getFieldId()][$old_option] == "sgl") {
                            $sel->setAlert($lng->txt("msg_input_is_required"));
                            ilUtil::sendFailure($lng->txt("form_input_not_valid"));
                        }
                    }
                    
                    $single->addSubItem($sel);
                }
            }
        }
    }

Here is the call graph for this function:

prepareElementForEditor()

ilAdvancedMDFieldDefinitionSelect::prepareElementForEditor

(

ilADTFormBridge

$a_enum

)

Definition at line 717 of file class.ilAdvancedMDFieldDefinitionSelect.php.

    {
        assert($a_enum instanceof ilADTEnumFormBridge);
        
        $a_enum->setAutoSort(false);
    }

save()

ilAdvancedMDFieldDefinitionSelect::save

(

$a_keep_pos = false

)

Definition at line 528 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References saveOptionTranslations().

    {
        parent::save($a_keep_pos);
        $this->saveOptionTranslations();
    }

Here is the call graph for this function:

saveOptionTranslations()

ilAdvancedMDFieldDefinitionSelect::saveOptionTranslations ( )

protected

Definition at line 553 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References $DIC, $options, $query, ilAdvancedMDFieldDefinition\getFieldId(), getOptionTranslations(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by save(), and updateOptionTranslations().

    {
        global $DIC;

        $db = $DIC->database();

        foreach ($this->getOptionTranslations() as $lang_key => $options) {
            foreach ($options as $idx => $option) {
                $query = 'insert into adv_mdf_enum (field_id, lang_code, idx, value )' .
                    'values (  ' .
                    $db->quote($this->getFieldId(), ilDBConstants::T_INTEGER) . ', ' .
                    $db->quote($lang_key, ilDBConstants::T_TEXT) . ', ' .
                    $db->quote($idx, ilDBConstants::T_INTEGER) . ', ' .
                    $db->quote($option, ilDBConstants::T_TEXT) .
                    ')' ;
                $db->manipulate($query);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setOptions()

ilAdvancedMDFieldDefinitionSelect::setOptions

(

array

$a_values = null

)

Set options.

Parameters

array

$a_values

Definition at line 71 of file class.ilAdvancedMDFieldDefinitionSelect.php.

Referenced by import(), and importFieldDefinition().

    {
        if ($a_values !== null) {
            foreach ($a_values as $idx => $value) {
                $a_values[$idx] = trim($value);
                if (!$a_values[$idx]) {
                    unset($a_values[$idx]);
                }
            }
            $a_values = array_unique($a_values);
            // sort($a_values);
        }
        $this->options = $a_values;
    }

Here is the caller graph for this function:

setOptionTranslations()

ilAdvancedMDFieldDefinitionSelect::setOptionTranslations

(

array

$translations

)

Parameters

array

$translations

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

Referenced by import(), and importTranslatedFormPostValues().

    {
        $this->option_translations = $translations;
    }

Here is the caller graph for this function:

setOptionTranslationsForLanguage()

ilAdvancedMDFieldDefinitionSelect::setOptionTranslationsForLanguage	(	array	$translations,
		string	$language
	)

Parameters

array	$translations
string	$language

Definition at line 124 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References ilAdvancedMDFieldDefinition\$language.

Referenced by importNewSelectOptions().

    {
        $this->option_translations[$language] = $translations;
    }

Here is the caller graph for this function:

update()

ilAdvancedMDFieldDefinitionSelect::update

(

)

Definition at line 578 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References ilADTActiveRecordByType\create(), ilADTActiveRecordByType\deleteByPrimary(), findBySingleValue(), ilAdvancedMDFieldDefinition\getADTDefinition(), ilAdvancedMDFieldDefinition\getFieldId(), ilADTFactory\getInstance(), ilADTFactory\initActiveRecordByType(), ilPCAMDPageList\migrateField(), ilDBConstants\T_INTEGER, and updateOptionTranslations().

    {
        if (is_array($this->confirmed_objects) && count($this->confirmed_objects) > 0) {
            // we need the "old" options for the search
            $def = $this->getADTDefinition();
            $def = clone($def);
            $def->setOptions($this->old_options);
            $search = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($def, false, true);
            ilADTFactory::initActiveRecordByType();

            $page_list_mappings = [];

            foreach ($this->confirmed_objects as $old_option => $item_ids) {
                // get complete old values
                $old_values = array();
                foreach ($this->findBySingleValue($search, $old_option) as $item) {
                    $old_values[$item[0] . "_" . $item[1] . "_" . $item[2]] = $item[3];
                }


                foreach ($item_ids as $item => $new_option) {
                    $parts = explode("_", $item);
                    $obj_id = $parts[0];
                    $sub_type = $parts[1];
                    $sub_id = $parts[2];

                    // update existing value (with changed option)
                    if (isset($old_values[$item])) {
                        $old_value = $old_values[$item];
                        // find changed option in old value
                        //$old_value = explode(ilADTMultiEnumDBBridge::SEPARATOR, $old_values[$item]);
                        // remove separators
                        //array_shift($old_value);
                        //array_pop($old_value);


                        //$old_idx = array_keys($old_value, $old_option);
                        $old_idx = $old_value;
                        if (isset($old_idx)) {
                            $primary = array(
                            "obj_id" => array("integer", $obj_id),
                            "sub_type" => array("text", $sub_type),
                            "sub_id" => array("integer", $sub_id),
                            "field_id" => array("integer", $this->getFieldId())
                        );

                            $index_old = array_merge(
                                $primary,
                                [
                                    'value_index' => [ilDBConstants::T_INTEGER, $old_idx]
                                ]
                            );
                            $index_new = array_merge(
                                $primary,
                                [
                                    'value_index' => [ilDBConstants::T_INTEGER, $new_option]
                                ]
                            );
                            ilADTActiveRecordByType::deleteByPrimary('adv_md_values', $index_old, 'MultiEnum');

                            if (is_numeric($new_option)) {
                                ilADTActiveRecordByType::deleteByPrimary('adv_md_values', $index_new, 'MultiEnum');
                                ilADTActiveRecordByType::create('adv_md_values', $index_new, 'MultiEnum');
                            } else {
                            }
                        }
                    }
                    
                    if ($sub_type == "wpg") {
                        // #15763 - adapt advmd page lists
                        $page_list_mappings[(string) $old_option] = (string) $new_option;
                    }
                }
            }

            if (!empty($page_list_mappings)) {
                ilPCAMDPageList::migrateField(
                    $this->getFieldId(),
                    $page_list_mappings
                );
            }

            $this->confirmed_objects = array();
        }

        parent::update();
        $this->updateOptionTranslations();
    }

Here is the call graph for this function:

updateOptionTranslations()

ilAdvancedMDFieldDefinitionSelect::updateOptionTranslations ( )

protected

Definition at line 547 of file class.ilAdvancedMDFieldDefinitionSelect.php.

References deleteOptionTranslations(), and saveOptionTranslations().

Referenced by update().

    {
        $this->deleteOptionTranslations();
        $this->saveOptionTranslations();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$confirm_objects

ilAdvancedMDFieldDefinitionSelect::$confirm_objects = []

protected

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

$confirm_objects_values

ilAdvancedMDFieldDefinitionSelect::$confirm_objects_values = []

protected

Definition at line 18 of file class.ilAdvancedMDFieldDefinitionSelect.php.

$confirmed_objects

ilAdvancedMDFieldDefinitionSelect::$confirmed_objects

protected

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

$option_translations

ilAdvancedMDFieldDefinitionSelect::$option_translations = []

protected

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

Referenced by getOptionTranslations().

$options

ilAdvancedMDFieldDefinitionSelect::$options = []

protected

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

Referenced by _clone(), addCustomFieldToDefinitionForm(), getFieldDefinitionForTableGUI(), getOptions(), import(), importNewSelectOptions(), ilAdvancedMDFieldDefinitionSelectMulti\initADTDefinition(), initADTDefinition(), prepareCustomDefinitionFormConfirmation(), and saveOptionTranslations().

REMOVE_ACTION_ID

const ilAdvancedMDFieldDefinitionSelect::REMOVE_ACTION_ID = "-iladvmdrm-"

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

---

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

• Services/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionSelect.php