ilAdvancedMDFieldDefinitionSelect Class Reference

AMD field type select. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionSelect:

Collaboration diagram for ilAdvancedMDFieldDefinitionSelect:

Public Member Functions
	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...

Protected Member Functions
	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...

Protected Attributes
	$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

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

addCustomFieldToDefinitionForm()

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

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled

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

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

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

ilAdvancedMDFieldDefinitionSelect::addPropertiesToXML ( ilXmlWriter  $a_writer )

protected

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

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

        {
                foreach($this->getOptions() as $value)
                {                       
                        $a_writer->xmlElement('FieldValue',null,$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 140 of file class.ilAdvancedMDFieldDefinitionSelect.php.

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

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

        {
                // #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")
                                {                                               
                                        foreach(array_keys($sgl_act) as $obj_idx)
                                        {
                                                $res[$old_option][$obj_idx] = $sum_act;
                                        }
                                }
                                else
                                {
                                        $res[$old_option] = $sgl_act;
                                }
                        }
                        
                        return $res;
                }               
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldDefinition()

ilAdvancedMDFieldDefinitionSelect::getFieldDefinition ( )

protected

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

References $options.

        {
                return $this->options;
        }

getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionSelect::getFieldDefinitionForTableGUI

(

)

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

References $lng, and getOptions().

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

Here is the call graph for this function:

getOptions()

ilAdvancedMDFieldDefinitionSelect::getOptions

(

)

Get options.

Returns

array

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

References $options.

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

        {
                return $this->options;
        }

Here is the caller graph for this function:

getType()

ilAdvancedMDFieldDefinitionSelect::getType

(

)

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

        {
                return self::TYPE_SELECT;
        }

getValueForXML()

ilAdvancedMDFieldDefinitionSelect::getValueForXML

(

ilADT

$element

)

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

        {
                return $element->getSelection();
        }

importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionSelect::importCustomDefinitionFormPostValues

(

ilPropertyFormGUI

$a_form

)

Import custom post values from definition form.

Parameters

ilPropertyFormGUI

$a_form

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

References buildConfirmedObjects(), ilAdvancedMDFieldDefinition\getFieldId(), ilPropertyFormGUI\getInput(), getOptions(), ilADTFactory\initActiveRecordByType(), ilADTActiveRecordByType\readByPrimary(), setOptions(), and ilADTActiveRecordByType\SINGLE_COLUMN_NAME.

        {               
                $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))
                        {                                       
                                ilADTFactory::initActiveRecordByType();
                                $primary = array(
                                        "field_id" => array("integer", $this->getFieldId()),
                                        ilADTActiveRecordByType::SINGLE_COLUMN_NAME => array("text", $missing)
                                );
                                $in_use = ilADTActiveRecordByType::readByPrimary("adv_md_values", $primary, "Enum");                            
                                if($in_use)
                                {
                                        $this->confirm_objects = array();
                                        foreach($in_use as $item)
                                        {
                                                $this->confirm_objects[$item[ilADTActiveRecordByType::SINGLE_COLUMN_NAME]][] = array($item["obj_id"], $item["sub_type"], $item["sub_id"]);
                                        }
                                }
                        }
                }
                
                $this->setOptions($new);        
        }       

Here is the call graph for this function:

importDefinitionFormPostValuesNeedsConfirmation()

ilAdvancedMDFieldDefinitionSelect::importDefinitionFormPostValuesNeedsConfirmation

(

)

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

References $confirm_objects.

        {
                return sizeof($this->confirm_objects);
        }

importFieldDefinition()

ilAdvancedMDFieldDefinitionSelect::importFieldDefinition ( array  $a_def )

protected

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

References setOptions().

        {
                $this->setOptions($a_def);
        }

Here is the call graph for this function:

importValueFromXML()

ilAdvancedMDFieldDefinitionSelect::importValueFromXML

(

$a_cdata

)

Definition at line 380 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
	)

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

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

initADTDefinition()

ilAdvancedMDFieldDefinitionSelect::initADTDefinition ( )

protected

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

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

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

Here is the call graph for this function:

prepareCustomDefinitionFormConfirmation()

ilAdvancedMDFieldDefinitionSelect::prepareCustomDefinitionFormConfirmation

(

ilPropertyFormGUI

$a_form

)

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

References $lng, $options, ilAdvancedMDFieldDefinition\$title, ilObject\_lookupType(), ilPropertyFormGUI\addItem(), ilPropertyFormGUI\getInput(), and ilPropertyFormGUI\getItemByPostVar().

        {
                global $lng, $objDefinition;
                
                $a_form->getItemByPostVar("opts")->setDisabled(true);
                
                if(sizeof($this->confirm_objects))
                {                       
                        $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)
                        {
                                $details = new ilRadioGroupInputGUI($lng->txt("md_adv_confirm_definition_select_option").': "'.$old_option.'"', "conf_det[".$this->getFieldId()."][".$old_option."]");                  
                                $details->setRequired(true);                    
                                $details->setValue("sum");
                                $a_form->addItem($details);
                                
                                $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."]");                                      
                                $options = array(""=>$lng->txt("md_adv_confirm_definition_select_option_remove"));
                                foreach($new_options as $new_option)
                                {
                                        $options[$new_option] = $lng->txt("md_adv_confirm_definition_select_option_overwrite").': "'.$new_option.'"';
                                }
                                $sel->setOptions($options);
                                $sum->addSubItem($sel);
                                
                                $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";
                                                if(class_implements($class, ilAdvancedMetaDataSubItem))
                                                {
                                                        $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."]");                                        
                                        $options = array(""=>$lng->txt("md_adv_confirm_definition_select_option_remove"));
                                        foreach($new_options as $new_option)
                                        {
                                                $options[$new_option] = $lng->txt("md_adv_confirm_definition_select_option_overwrite").': "'.$new_option.'"';
                                        }
                                        $sel->setOptions($options);
                                        
                                        $single->addSubItem($sel);
                                }
                                
                                
                        }
                }               
        }

Here is the call graph for this function:

setOptions()

ilAdvancedMDFieldDefinitionSelect::setOptions

(

array

$a_values = null

)

Set options.

Parameters

array

$a_values

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

Referenced by ilAdvancedMDFieldDefinitionSelectMulti\importCustomDefinitionFormPostValues(), importCustomDefinitionFormPostValues(), 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:

update()

ilAdvancedMDFieldDefinitionSelect::update

(

)

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

References ilADTActiveRecordByType\deleteByPrimary(), ilAdvancedMDFieldDefinition\getFieldId(), ilADTFactory\initActiveRecordByType(), ilPCAMDPageList\migrateField(), and ilADTActiveRecordByType\writeByPrimary().

        {
                parent::update();
                
                if(sizeof($this->confirmed_objects))
                {
                        ilADTFactory::initActiveRecordByType();
                        foreach($this->confirmed_objects as $old_option => $item_ids)
                        {                               
                                foreach($item_ids as $item => $new_option)
                                {
                                        $item = explode("_", $item);
                                        $obj_id = $item[0];
                                        $sub_type = $item[1];
                                        $sub_id = $item[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, "Enum");
                                        }
                                        else
                                        {
                                                // update 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::writeByPrimary("adv_md_values", $primary, "Enum", $new_option);
                                        }
                                                                                
                                        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);                                                                                          
                                        }                                       
                                }                               
                        }                       
                }               
        }

Here is the call graph for this function:

Field Documentation

$confirm_objects

ilAdvancedMDFieldDefinitionSelect::$confirm_objects

protected

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

Referenced by importDefinitionFormPostValuesNeedsConfirmation().

$confirmed_objects

ilAdvancedMDFieldDefinitionSelect::$confirmed_objects

protected

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

$options

ilAdvancedMDFieldDefinitionSelect::$options = array()

protected

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

Referenced by addCustomFieldToDefinitionForm(), getFieldDefinition(), getOptions(), ilAdvancedMDFieldDefinitionSelectMulti\initADTDefinition(), initADTDefinition(), and prepareCustomDefinitionFormConfirmation().

---

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

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