AMD field type select. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionSelectMulti:

Collaboration diagram for ilAdvancedMDFieldDefinitionSelectMulti:

Public Member Functions
	getSearchQueryParserValue (ilADTSearchBridge $search_bridge)
	Get value for search query parser. More...

	getType ()
	Get type. More...

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

	getValueForXML (ilADT $element)
	Parse ADT value for xml (export) More...

	importValueFromXML ($a_cdata)
	Import value from xml. More...

	prepareElementForEditor (ilADTFormBridge $a_enum)
	Prepare editor form elements. More...

Public Member Functions inherited from ilAdvancedMDFieldDefinitionSelect
	getType ()
	Get type. More...

	getSearchQueryParserValue (ilADTSearchBridge $search_bridge)
	Get value for search query parser. More...

	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)
	Parse properties for table gui. More...

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
	Import custom post values from definition form. More...

	importDefinitionFormPostValuesNeedsConfirmation ()

	prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

	delete ()
	Delete field entry. More...

	save ($a_keep_pos=false)
	Create new field entry. More...

	update ()
	Update field entry. More...

	importXMLProperty ($a_key, $a_value)

	getValueForXML (ilADT $element)
	Parse ADT value for xml (export) More...

	importValueFromXML ($a_cdata)
	Import value from xml. More...

	prepareElementForEditor (ilADTFormBridge $a_enum)
	Prepare editor form elements. More...

	_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	XML_SEPARATOR = "~\|~"

Data Fields inherited from ilAdvancedMDFieldDefinitionSelect
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 ()
	Init adt instance. More...

Protected Member Functions inherited from ilAdvancedMDFieldDefinitionSelect
	initADTDefinition ()
	Init adt instance. More...

	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)
	Add (type-specific) properties to xml export. More...

	import (array $db_data)
	Import from DB. More...

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

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

Protected Attributes inherited from ilAdvancedMDFieldDefinitionSelect
	$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

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.ilAdvancedMDFieldDefinitionSelectMulti.php.

Member Function Documentation

◆ getSearchQueryParserValue()

ilAdvancedMDFieldDefinitionSelectMulti::getSearchQueryParserValue ( ilADTSearchBridge $a_adt_search )

Get value for search query parser.

Parameters

ilADTSearchBridge $a_adt_search

Returns: mixed

Reimplemented from ilAdvancedMDFieldDefinitionSelect.

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

    {
        return $search_bridge->getADT()->getSelections()[0] ?? 0;
    }

◆ getType()

ilAdvancedMDFieldDefinitionSelectMulti::getType ( )

Get type.

Returns: int

Reimplemented from ilAdvancedMDFieldDefinitionSelect.

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

    {
        return self::TYPE_SELECT_MULTI;
    }

References ilAdvancedMDFieldDefinition\TYPE_SELECT_MULTI.

◆ getValueForXML()

ilAdvancedMDFieldDefinitionSelectMulti::getValueForXML ( ilADT $element )

Parse ADT value for xml (export)

Parameters

ilADT $element

Returns: string

Reimplemented from ilAdvancedMDFieldDefinitionSelect.

Definition at line 76 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.

    {
        return self::XML_SEPARATOR .
            implode(self::XML_SEPARATOR, $element->getSelections()) .
            self::XML_SEPARATOR;
    }

References XML_SEPARATOR.

◆ importCustomDefinitionFormPostValues()

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

Parameters

ilPropertyFormGUI	$a_form
string	$language

Reimplemented from ilAdvancedMDFieldDefinitionSelect.

Definition at line 60 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.

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

References ilAdvancedMDFieldDefinition\$language, and ilAdvancedMDFieldDefinitionSelect\importNewSelectOptions().

Here is the call graph for this function:

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionSelectMulti::importValueFromXML ( $a_cdata )

Import value from xml.

Parameters

string $a_cdata

Reimplemented from ilAdvancedMDFieldDefinitionSelect.

Definition at line 83 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.

    {
        $this->getADT()->setSelections(explode(self::XML_SEPARATOR, $a_cdata));
    }

References ilAdvancedMDFieldDefinition\getADT().

Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionSelectMulti::initADTDefinition ( )

protected

Init adt instance.

Returns: ilADTDefinition

Reimplemented from ilAdvancedMDFieldDefinitionSelect.

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

    {
        $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("MultiEnum");
        $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;
    }

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

Here is the call graph for this function:

◆ prepareElementForEditor()

ilAdvancedMDFieldDefinitionSelectMulti::prepareElementForEditor ( ilADTFormBridge $a_bridge )

Prepare editor form elements.

Parameters

ilADTFormBridge $a_bridge

Reimplemented from ilAdvancedMDFieldDefinitionSelect.

Definition at line 93 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.

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

Field Documentation

◆ XML_SEPARATOR

const ilAdvancedMDFieldDefinitionSelectMulti::XML_SEPARATOR = "~|~"

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

Referenced by getValueForXML().

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

Services/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionSelectMulti.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getSearchQueryParserValue()

◆ getType()

◆ getValueForXML()

◆ importCustomDefinitionFormPostValues()

◆ importValueFromXML()

◆ initADTDefinition()

◆ prepareElementForEditor()

Field Documentation

◆ XML_SEPARATOR