AMD field type select. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionSelectMulti:

Collaboration diagram for ilAdvancedMDFieldDefinitionSelectMulti:

Public Member Functions
	getType ()

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)

	update ()

	getValueForXML (ilADT $element)

	importValueFromXML ($a_cdata)

Public Member Functions inherited from ilAdvancedMDFieldDefinitionSelect
	getType ()

	setOptions (array $a_values=null)
	Set options. More...

	getOptions ()
	Get options. More...

	getFieldDefinitionForTableGUI ()

	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false)
	Add input elements to definition form. More...

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
	Import custom post values from definition form. More...

	importDefinitionFormPostValuesNeedsConfirmation ()

	prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

	update ()

	importXMLProperty ($a_key, $a_value)

	getValueForXML (ilADT $element)

	importValueFromXML ($a_cdata)

Public Member Functions inherited from ilAdvancedMDFieldDefinition
	__construct ($a_field_id=null)
	Constructor. More...

	getType ()
	Get type. 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...

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

	isSearchable ()
	Is searchable. More...

	setRequired ($a_status)
	Toggle required. More...

	isRequired ()
	Is required field. More...

	getFieldDefinitionForTableGUI ()
	Parse properties for table gui. More...

	addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
	Add input elements to definition form. More...

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
	Import custom post values from definition form. More...

	importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
	Import post values from definition form. More...

	importDefinitionFormPostValuesNeedsConfirmation ()

	prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

	prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

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

Data Fields
const	XML_SEPARATOR = "~\|~"

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

Protected Member Functions
	initADTDefinition ()

	findBySingleValue (ilADTEnumSearchBridgeMulti $a_search, $a_value)

Protected Member Functions inherited from ilAdvancedMDFieldDefinitionSelect
	initADTDefinition ()

	importFieldDefinition (array $a_def)

	getFieldDefinition ()

	buildConfirmedObjects (ilPropertyFormGUI $a_form)
	Process custom post values from definition form. More...

	addPropertiesToXML (ilXmlWriter $a_writer)

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)
	Add custom input elements to definition form. More...

	getLastPosition ()
	Get last position of record. More...

	generateImportId ($a_field_id)
	Generate unique record id. 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)
	Get definition instance by type. More...

static	getInstanceByTypeString ($a_type)
	Get instance by type string (used by import) More...

static	getInstancesByRecordId ($a_record_id, $a_only_searchable=false)
	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 = array()

	$confirm_objects

	$confirmed_objects

Protected Attributes inherited from ilAdvancedMDFieldDefinition
	$field_id

	$record_id

	$import_id

	$position

	$title

	$description

	$searchable

	$required

	$adt_def

	$adt

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

◆ findBySingleValue()

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

protected

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

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

Referenced by importCustomDefinitionFormPostValues(), and update().

         {
                 $res = array();
                 
                 $a_search->getADT()->setSelections(array($a_value));    
                 $condition = $a_search->getSQLCondition(ilADTActiveRecordByType::SINGLE_COLUMN_NAME);
                                         
                 $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"]);
                         }
                 }       
                 
                 return $res;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilAdvancedMDFieldDefinitionSelectMulti::getType ( )

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

         {
                 return self::TYPE_SELECT_MULTI;
         }

◆ getValueForXML()

ilAdvancedMDFieldDefinitionSelectMulti::getValueForXML ( ilADT $element )

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

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

◆ importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionSelectMulti::importCustomDefinitionFormPostValues ( ilPropertyFormGUI $a_form )

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

References ilAdvancedMDFieldDefinitionSelect\buildConfirmedObjects(), findBySingleValue(), ilAdvancedMDFieldDefinition\getADTDefinition(), ilPropertyFormGUI\getInput(), ilADTFactory\getInstance(), ilAdvancedMDFieldDefinitionSelect\getOptions(), ilADTFactory\initActiveRecordByType(), and ilAdvancedMDFieldDefinitionSelect\setOptions().

         {       
                 $old = $this->getOptions();
                 $new = $a_form->getInput("opts");
                 
                 $missing = array_diff($old, $new);
                 if(sizeof($missing))
                 {               
                         $this->confirmed_objects = $this->buildConfirmedObjects($a_form);
                         if(!is_array($this->confirmed_objects))
                         {                                                                       
                                 $search = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($this->getADTDefinition(), false, false);                                                   
                                 ilADTFactory::initActiveRecordByType();
                                 
                                 foreach($missing as $missing_value)
                                 {                                       
                                         $in_use = $this->findBySingleValue($search, $missing_value);                            
                                         if(sizeof($in_use))
                                         {
                                                 foreach($in_use as $item)
                                                 {
                                                         $this->confirm_objects[$missing_value][] = $item;
                                                 }
                                         }                                       
                                 }                               
                         }
                 }
                 
                 $this->old_options = $old;
                 $this->setOptions($new);        
         }

Here is the call graph for this function:

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionSelectMulti::importValueFromXML ( $a_cdata )

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

References ilAdvancedMDFieldDefinition\getADT().

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

Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionSelectMulti::initADTDefinition ( )

protected

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

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

         {               
                 $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("MultiEnum");
                 $def->setNumeric(false);
                 
                 $options = $this->getOptions();
                 $def->setOptions(array_combine($options, $options));
                 
                 // see ilAdvancedMDValues::getActiveRecord()
                 // using ilADTMultiEnumDBBridge::setFakeSingle()
                 
                 return $def;
         }       

Here is the call graph for this function:

◆ update()

ilAdvancedMDFieldDefinitionSelectMulti::update ( )

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

References ilADTActiveRecordByType\deleteByPrimary(), findBySingleValue(), ilAdvancedMDFieldDefinition\getADTDefinition(), ilAdvancedMDFieldDefinition\getFieldId(), ilADTFactory\getInstance(), ilADTFactory\initActiveRecordByType(), ilPCAMDPageList\migrateField(), ilADTMultiEnumDBBridge\SEPARATOR, and ilADTActiveRecordByType\writeByPrimary().

         {               
                 if(sizeof($this->confirmed_objects))
                 {
                         // we need the "old" options for the search
                         $def = $this->getADTDefinition();
                         $def = clone($def);
                         $def->setOptions(array_combine($this->old_options, $this->old_options));                        
                         $search = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($def, false, false);                        
                         ilADTFactory::initActiveRecordByType();
                         
                         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];
                                         
                                         if(!$new_option)
                                         {
                                                 // remove existing value                                        
                                                 $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())
                                                 );
                                                 ilADTActiveRecordByType::deleteByPrimary("adv_md_values", $primary, "MultiEnum");
                                         }
                                         else
                                         {               
                                                 // update existing value (with changed option)                                          
                                                 if(isset($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);                                                 
                                                         if(sizeof($old_idx))
                                                         {
                                                                 // switch option
                                                                 $old_idx = array_pop($old_idx);                                         
                                                                 $old_value[$old_idx] = $new_option;                                                                     
                                                                 $new_value = array_unique($old_value);  
                                                                 // add separators
                                                                 $new_value = ilADTMultiEnumDBBridge::SEPARATOR.
                                                                         implode(ilADTMultiEnumDBBridge::SEPARATOR, $new_value).
                                                                         ilADTMultiEnumDBBridge::SEPARATOR;
                                                                 
                                                                 $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())
                                                                 );
                                                                 ilADTActiveRecordByType::writeByPrimary("adv_md_values", $primary, "MultiEnum", $new_value);
                                                         }
                                                 }                       
                                         }
                                                                                 
                                         if($sub_type == "wpg")
                                         {
                                                 // #15763 - adapt advmd page lists
                                                 include_once "Modules/Wiki/classes/class.ilPCAMDPageList.php";
                                                 ilPCAMDPageList::migrateField($obj_id, $this->getFieldId(), $old_option, $new_option, true);                                                                                            
                                         }       
                                 }                               
                         }                       
                         
                         $this->confirmed_objects = array();
                 }       
                         
                 parent::update();               
         }

Here is the call graph for this function:

Field Documentation

◆ XML_SEPARATOR

const ilAdvancedMDFieldDefinitionSelectMulti::XML_SEPARATOR = "~|~"

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

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

◆ findBySingleValue()

◆ getType()

◆ getValueForXML()

◆ importCustomDefinitionFormPostValues()

◆ importValueFromXML()

◆ initADTDefinition()

◆ update()

Field Documentation

◆ XML_SEPARATOR