AMD field type address. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionGroupBased:

Collaboration diagram for ilAdvancedMDFieldDefinitionGroupBased:

Public Member Functions
	setOptions (array $a_values=null)

	getOptions ()

	getFieldDefinitionForTableGUI (string $content_language)

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

	importXMLProperty (string $a_key, string $a_value)

	getValueForXML (ilADT $element)

	importValueFromXML (string $a_cdata)

	getADTGroup ()

	getTitles ()

	hasComplexOptions ()

	getComplexOptionsOverview (object $a_parent_gui, string $a_parent_cmd)

	exportOptionToTableGUI ($a_option, array &$a_item)

	initOptionForm (ilPropertyFormGUI $a_form, $a_option_id)

	updateComplexOption (ilPropertyFormGUI $a_form, $a_option_id)

Public Member Functions inherited from ilAdvancedMDFieldDefinition
	__construct (?int $a_field_id=null, string $language='')

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

	getADTDefinition ()
	Get ADT definition instance. More...

	getADT ()

	getFieldId ()
	Get field_id. More...

	setRecordId (int $a_id)
	Set record id. More...

	getRecordId ()
	Get record id. More...

	setImportId (string $a_id_string)
	Set import id. More...

	getImportId ()
	Get import id. More...

	setPosition (int $a_pos)
	Set position. More...

	getPosition ()
	Get position. More...

	setTitle (string $a_title)
	Get title. More...

	getTitle ()
	Get title. More...

	setDescription (string $a_desc)
	Set description. More...

	getDescription ()
	Get description. More...

	isSearchSupported ()
	Is search supported at all. More...

	isFilterSupported ()
	Is search by filter supported. More...

	setSearchable (bool $a_status)
	Toggle searchable. More...

	isSearchable ()
	Is searchable. More...

	setRequired (bool $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 (int $a_field_id)
	Generate unique record id. More...

	save (bool $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 (string $a_key, string $a_value)
	Import property from XML. More...

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

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

	importFromECS (string $a_ecs_type, $a_value, string $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)

	setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)
	Set value from search persistence. More...

	searchSubObjects (ilADTSearchBridge $a_adt_search, int $a_obj_id, string $sub_obj_type)

	searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, string $a_locate, string $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 (int $a_new_record_id)
	Clone field definition. More...

	hasComplexOptions ()

	getComplexOptionsOverview (object $a_parent_gui, string $parent_cmd)

Protected Member Functions
	initADTDefinition ()

	importFieldDefinition (array $a_def)

	getFieldDefinition ()

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

	addPropertiesToXML (ilXmlWriter $a_writer)

	getADTForOption (string $a_option)

	importComplexOptionFromForm (string $a_option, ilADT $a_adt)

	findOptionById (string $a_id)

Protected Member Functions inherited from ilAdvancedMDFieldDefinition
	init ()

	initADTDefinition ()
	Init adt instance. More...

	setADT (ilADT $a_adt)
	Set ADT instance. More...

	setFieldId (int $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, bool $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 (?int $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 = []

	$complex = []

Protected Attributes inherited from ilAdvancedMDFieldDefinition
int	$field_id = null

int	$record_id = 0

string	$import_id = ''

int	$position = 0

string	$title = ''

string	$description = ''

bool	$searchable = false

bool	$required = false

ilADTDefinition	$adt_def = null

ilADT	$adt = null

string	$language = ''

ilDBInterface	$db

ilLanguage	$lng

ilLogger	$logger

GlobalHttpState	$http

RefineryFactory	$refinery

Additional Inherited Members
Static Public Member Functions inherited from ilAdvancedMDFieldDefinition
static	getInstance (?int $a_field_id, ?int $a_type=null, string $language='')

static	exists (int $a_field_id)

static	getInstanceByTypeString (string $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 (string $a_import_id)

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 (int $a_type)

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

Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static	getTypeString (int $a_type)
	Get type as string. More...

Detailed Description

AMD field type address.

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

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

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

ilAdvancedMDFieldDefinitionGroupBased::addCustomFieldToDefinitionForm	(	ilPropertyFormGUI	$a_form,
		bool	$a_disabled = `false`,
		string	$language = `''`
	)

protected

Definition at line 85 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References ilAdvancedMDFieldDefinition\$lng, $options, ilPropertyFormGUI\addItem(), and getOptions().

      : void {
         global $lng;
 
         $field = new ilTextInputGUI($lng->txt("options"), "opts");
         $field->setRequired(true);
         $field->setMulti(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:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionGroupBased::addPropertiesToXML ( ilXmlWriter $a_writer )

protected

Definition at line 129 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

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

                                                                 : void
     {
         foreach ($this->getOptions() as $value) {
             $a_writer->xmlElement('FieldValue', null, $value);
         }
     }

Here is the call graph for this function:

◆ exportOptionToTableGUI()

ilAdvancedMDFieldDefinitionGroupBased::exportOptionToTableGUI	(		$a_option,
		array &	$a_item
	)

Definition at line 203 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References ilAdvancedMDFieldDefinition\$adt, ilAdvancedMDFieldDefinition\$title, getADTForOption(), and ilADTFactory\getInstance().

                                                                      : void
     {
         $adt = $this->getADTForOption($a_option);
         foreach ($adt->getElements() as $title => $element) {
             $pres = ilADTFactory::getInstance()->getPresentationBridgeForInstance($element);
             $a_item[$title] = $pres->getList();
         }
     }

Here is the call graph for this function:

◆ findOptionById()

ilAdvancedMDFieldDefinitionGroupBased::findOptionById ( string $a_id )

protected

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

References getOptions().

Referenced by initOptionForm(), and updateComplexOption().

                                                    : ?string
     {
         foreach ($this->getOptions() as $item) {
             if (md5($item) == $a_id) {
                 return $item;
             }
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getADTForOption()

ilAdvancedMDFieldDefinitionGroupBased::getADTForOption ( string $a_option )

protected

Definition at line 185 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References ilAdvancedMDFieldDefinition\$adt, getADTGroup(), ilADTFactory\getInstance(), and ilADT\importStdClass().

Referenced by exportOptionToTableGUI(), and initOptionForm().

                                                         : ilADT
     {
         $adt = ilADTFactory::getInstance()->getInstanceByDefinition($this->getADTGroup());
         if (array_key_exists($a_option, $this->complex)) {
             $adt->importStdClass($this->complex[$a_option]);
         }
         return $adt;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getADTGroup()

ilAdvancedMDFieldDefinitionGroupBased::getADTGroup ( )

abstract

Referenced by getADTForOption(), importValueFromXML(), and updateComplexOption().

Here is the caller graph for this function:

◆ getComplexOptionsOverview()

ilAdvancedMDFieldDefinitionGroupBased::getComplexOptionsOverview	(	object	$a_parent_gui,
		string	$a_parent_cmd
	)

Definition at line 197 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

                                                                                          : ?string
     {
         $tbl = new ilAdvancedMDFieldDefinitionGroupTableGUI($a_parent_gui, $a_parent_cmd, $this);
         return $tbl->getHTML();
     }

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionGroupBased::getFieldDefinition ( )

protected

Definition at line 67 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

                                            : array
     {
         return array(
             "options" => $this->options,
             "complex" => $this->complex
         );
     }

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionGroupBased::getFieldDefinitionForTableGUI ( string $content_language )

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

References ilAdvancedMDFieldDefinition\$lng, and getOptions().

                                                                            : array
     {
         global $lng;
 
         return array($lng->txt("options") => implode(",", $this->getOptions()));
     }

Here is the call graph for this function:

◆ getOptions()

ilAdvancedMDFieldDefinitionGroupBased::getOptions ( )

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

References $options.

Referenced by addCustomFieldToDefinitionForm(), addPropertiesToXML(), findOptionById(), getFieldDefinitionForTableGUI(), importCustomDefinitionFormPostValues(), and initADTDefinition().

                                 : array
     {
         return $this->options;
     }

Here is the caller graph for this function:

◆ getTitles()

ilAdvancedMDFieldDefinitionGroupBased::getTitles ( )

abstract

Referenced by importValueFromXML(), and initOptionForm().

Here is the caller graph for this function:

◆ getValueForXML()

ilAdvancedMDFieldDefinitionGroupBased::getValueForXML ( ilADT $element )

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

Referenced by ilAdvancedMDFieldDefinitionText\importXMLProperty().

                                                   : string
     {
         return $element->getSelection();
     }

Here is the caller graph for this function:

◆ hasComplexOptions()

ilAdvancedMDFieldDefinitionGroupBased::hasComplexOptions ( )

Definition at line 180 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

                                        : bool
     {
         return true;
     }

◆ importComplexOptionFromForm()

ilAdvancedMDFieldDefinitionGroupBased::importComplexOptionFromForm	(	string	$a_option,
		ilADT	$a_adt
	)

protected

Definition at line 253 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References ilADT\exportStdClass().

Referenced by updateComplexOption().

     {
         $this->complex[$a_option] = $a_adt->exportStdClass();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importCustomDefinitionFormPostValues()

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

Definition at line 112 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References ilPropertyFormGUI\getInput(), getOptions(), and setOptions().

                                                                                                           : void
     {
         $old = $this->getOptions();
         $new = $a_form->getInput("opts");
 
         if (is_array($old)) {
             $missing = array_diff($old, $new);
             if (sizeof($missing)) {
                 foreach ($missing as $item) {
                     unset($this->complex[$item]);
                 }
             }
         }
 
         $this->setOptions($new);
     }

Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionGroupBased::importFieldDefinition ( array $a_def )

protected

Definition at line 61 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References setOptions().

                                                           : void
     {
         $this->setOptions($a_def["options"]);
         $this->complex = $a_def["complex"];
     }

Here is the call graph for this function:

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionGroupBased::importValueFromXML ( string $a_cdata )

Definition at line 151 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References ilAdvancedMDFieldDefinition\getADT(), getADTGroup(), and getTitles().

                                                        : void
     {
         /*
          * On import from <7 options are not given by index but by
          * their label. There is nothing in the XML by which one could
          * tell apart legacy and standard imports, so we have to
          * make a best guess here (32410).
          *
          * Might fail for enums where the labels are integers.
          * See also ilAdvancedMDFieldDefinitionSelect::translateLegacyImportValueFromXML.
          */
         if (
             !in_array($a_cdata, array_keys($this->options)) &&
             in_array($a_cdata, $this->options)
         ) {
             $a_cdata = (string) array_search($a_cdata, $this->options);
         }
         $this->getADT()->setSelection($a_cdata);
     }

Here is the call graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinitionGroupBased::importXMLProperty	(	string	$a_key,
		string	$a_value
	)

Definition at line 136 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

                                                                      : void
     {
         $this->options[] = $a_value;
     }

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionGroupBased::initADTDefinition ( )

protected

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

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

                                           : ilADTDefinition
     {
         $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Enum");
         $def->setNumeric(false);
 
         $options = $this->getOptions();
         $def->setOptions($options);
         return $def;
     }

Here is the call graph for this function:

◆ initOptionForm()

ilAdvancedMDFieldDefinitionGroupBased::initOptionForm	(	ilPropertyFormGUI	$a_form,
			$a_option_id
	)

Definition at line 212 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

References ilAdvancedMDFieldDefinition\$adt, $id, ilAdvancedMDFieldDefinition\$lng, ilAdvancedMDFieldDefinition\$title, ilPropertyFormGUI\addItem(), findOptionById(), getADTForOption(), ilADTFactory\getInstance(), and getTitles().

     {
         global $lng;
 
         $option = $this->findOptionById($a_option_id);
         if ($option) {
             $title = new ilTextInputGUI($lng->txt("option"), "option");
             $title->setValue($option);
             $title->setDisabled(true);
             $a_form->addItem($title);
 
             $adt = $this->getADTForOption($option);
             $adt_form = ilADTFactory::getInstance()->getFormBridgeForInstance($adt);
             $adt_form->setForm($a_form);
 
             $titles = $this->getTitles();
             foreach ($adt_form->getElements() as $id => $element) {
                 $element->setTitle($titles[$id]);
             }
 
             $adt_form->addToForm();
         }
     }

Here is the call graph for this function:

◆ setOptions()

ilAdvancedMDFieldDefinitionGroupBased::setOptions ( array $a_values = null )

Definition at line 41 of file class.ilAdvancedMDFieldDefinitionGroupBased.php.

Referenced by importCustomDefinitionFormPostValues(), and importFieldDefinition().

                                                       : void
     {
         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:

◆ updateComplexOption()

ilAdvancedMDFieldDefinitionGroupBased::updateComplexOption	(	ilPropertyFormGUI	$a_form,
			$a_option_id
	)

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

References ilAdvancedMDFieldDefinition\$adt, findOptionById(), getADTGroup(), ilADTFactory\getInstance(), and importComplexOptionFromForm().

     {
         $option = $this->findOptionById($a_option_id);
         if ($option) {
             $adt = ilADTFactory::getInstance()->getInstanceByDefinition($this->getADTGroup());
             $adt_form = ilADTFactory::getInstance()->getFormBridgeForInstance($adt);
             $adt_form->setForm($a_form);
             if ($adt_form->validate()) {
                 $adt_form->importFromPost();
                 $this->importComplexOptionFromForm($option, $adt);
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $complex

ilAdvancedMDFieldDefinitionGroupBased::$complex = []

protected

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

◆ $options

ilAdvancedMDFieldDefinitionGroupBased::$options = []

protected

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

Referenced by addCustomFieldToDefinitionForm(), getOptions(), and initADTDefinition().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

◆ addPropertiesToXML()

◆ exportOptionToTableGUI()

◆ findOptionById()

◆ getADTForOption()

◆ getADTGroup()

◆ getComplexOptionsOverview()

◆ getFieldDefinition()

◆ getFieldDefinitionForTableGUI()

◆ getOptions()

◆ getTitles()

◆ getValueForXML()

◆ hasComplexOptions()

◆ importComplexOptionFromForm()

◆ importCustomDefinitionFormPostValues()

◆ importFieldDefinition()

◆ importValueFromXML()

◆ importXMLProperty()

◆ initADTDefinition()

◆ initOptionForm()

◆ setOptions()

◆ updateComplexOption()

Field Documentation

◆ $complex

◆ $options