ilAdvancedMDFieldDefinitionSelectMulti Class Reference
AMD field type select. More...
Inheritance diagram for ilAdvancedMDFieldDefinitionSelectMulti:
Collaboration diagram for ilAdvancedMDFieldDefinitionSelectMulti:
Public Member Functions | |
| getType () | |
| Get type. More... | |
| importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form) | |
| Import custom post values from definition form. More... | |
| update () | |
| Update field entry. More... | |
| getValueForXML (ilADT $element) | |
| Parse ADT value for xml (export) More... | |
| importValueFromXML ($a_cdata) | |
| Import value from xml. More... | |
| prepareElementForEditor (ilADTMultiEnumFormBridge $a_enum) | |
| Public Member Functions inherited from ilAdvancedMDFieldDefinitionSelect | |
| getType () | |
| Get type. More... | |
| setOptions (array $a_values=null) | |
| Set options. More... | |
| getOptions () | |
| Get options. More... | |
| getFieldDefinitionForTableGUI () | |
| Parse properties for table gui. More... | |
| 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 () | |
| Update field entry. 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... | |
| prepareElementForEditor (ilADTEnumFormBridge $a_enum) | |
| 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... | |
| 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 () | |
| 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) | |
| generateImportId ($a_field_id) | |
| Generate unique record id. More... | |
| 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 () | |
| Init adt instance. More... | |
| findBySingleValue (ilADTEnumSearchBridgeMulti $a_search, $a_value) | |
| Protected Member Functions inherited from ilAdvancedMDFieldDefinitionSelect | |
| initADTDefinition () | |
| Init adt instance. More... | |
| importFieldDefinition (array $a_def) | |
| Import (type-specific) field definition from DB. More... | |
| getFieldDefinition () | |
| Get (type-specific) field definition. More... | |
| buildConfirmedObjects (ilPropertyFormGUI $a_form) | |
| Process custom post values from definition form. More... | |
| addPropertiesToXML (ilXmlWriter $a_writer) | |
| Add (type-specific) properties to xml export. 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) | |
| 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) |
| 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.
- Version
- $Id$
Definition at line 14 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
Member Function Documentation
◆ findBySingleValue()
|
protected |
Definition at line 83 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
84 {
85 $res = array();
86
87 $a_search->getADT()->setSelections(array($a_value));
89
90 $in_use = ilADTActiveRecordByType::find(
91 "adv_md_values",
92 "Enum",
93 $this->getFieldId(),
94 $condition
95 );
96 if($in_use)
97 {
98 foreach($in_use as $item)
99 {
101 }
102 }
103
105 }
const SINGLE_COLUMN_NAME
Definition: class.ilADTActiveRecordByType.php:23
static find($a_table, $a_type, $a_field_id, $a_condition, $a_additional_fields=null)
Find entries.
Definition: class.ilADTActiveRecordByType.php:724
getSQLCondition($a_element_id)
Get SQL condition for current value(s)
Definition: class.ilADTEnumSearchBridgeMulti.php:105
References $res, ilADTActiveRecordByType\find(), ilADTSearchBridgeSingle\getADT(), ilAdvancedMDFieldDefinition\getFieldId(), ilADTEnumSearchBridgeMulti\getSQLCondition(), and ilADTActiveRecordByType\SINGLE_COLUMN_NAME.
Referenced by importCustomDefinitionFormPostValues(), and update().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getType()
| ilAdvancedMDFieldDefinitionSelectMulti::getType | ( | ) |
Get type.
- Returns
- int
Reimplemented from ilAdvancedMDFieldDefinitionSelect.
Definition at line 22 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
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 203 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
204 {
205 return self::XML_SEPARATOR.
206 implode(self::XML_SEPARATOR, $element->getSelections()).
207 self::XML_SEPARATOR;
208 }
const XML_SEPARATOR
References XML_SEPARATOR.
◆ importCustomDefinitionFormPostValues()
| ilAdvancedMDFieldDefinitionSelectMulti::importCustomDefinitionFormPostValues | ( | ilPropertyFormGUI | $a_form | ) |
Import custom post values from definition form.
- Parameters
-
ilPropertyFormGUI $a_form
Reimplemented from ilAdvancedMDFieldDefinitionSelect.
Definition at line 51 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
52 {
53 $old = $this->getOptions();
55
56 $missing = array_diff($old, $new);
57 if(sizeof($missing))
58 {
59 $this->confirmed_objects = $this->buildConfirmedObjects($a_form);
60 if(!is_array($this->confirmed_objects))
61 {
62 $search = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($this->getADTDefinition(), false, false);
64
65 foreach($missing as $missing_value)
66 {
67 $in_use = $this->findBySingleValue($search, $missing_value);
68 if(sizeof($in_use))
69 {
70 foreach($in_use as $item)
71 {
72 $this->confirm_objects[$missing_value][] = $item;
73 }
74 }
75 }
76 }
77 }
78
79 $this->old_options = $old;
80 $this->setOptions($new);
81 }
findBySingleValue(ilADTEnumSearchBridgeMulti $a_search, $a_value)
setOptions(array $a_values=null)
Set options.
Definition: class.ilAdvancedMDFieldDefinitionSelect.php:56
buildConfirmedObjects(ilPropertyFormGUI $a_form)
Process custom post values from definition form.
Definition: class.ilAdvancedMDFieldDefinitionSelect.php:140
getInput($a_post_var, $ensureValidation=true)
Returns the value of a HTTP-POST variable, identified by the passed id.
Definition: class.ilPropertyFormGUI.php:504
References ilAdvancedMDFieldDefinitionSelect\buildConfirmedObjects(), findBySingleValue(), ilAdvancedMDFieldDefinition\getADTDefinition(), ilPropertyFormGUI\getInput(), ilADTFactory\getInstance(), ilAdvancedMDFieldDefinitionSelect\getOptions(), ilADTFactory\initActiveRecordByType(), and ilAdvancedMDFieldDefinitionSelect\setOptions().
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 210 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
211 {
212 $this->getADT()->setSelections(explode(self::XML_SEPARATOR, $a_cdata));
213 }
References ilAdvancedMDFieldDefinition\getADT().
Here is the call graph for this function:
◆ initADTDefinition()
|
protected |
Init adt instance.
- Returns
- ilADTDefinition
Reimplemented from ilAdvancedMDFieldDefinitionSelect.
Definition at line 32 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
33 {
35 $def->setNumeric(false);
36
39
40 // see ilAdvancedMDValues::getActiveRecord()
41 // using ilADTMultiEnumDBBridge::setFakeSingle()
42
43 return $def;
44 }
References ilAdvancedMDFieldDefinitionSelect\$options, ilADTFactory\getInstance(), and ilAdvancedMDFieldDefinitionSelect\getOptions().
Here is the call graph for this function:
◆ prepareElementForEditor()
| ilAdvancedMDFieldDefinitionSelectMulti::prepareElementForEditor | ( | ilADTMultiEnumFormBridge | $a_enum | ) |
Definition at line 220 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
References ilADTMultiEnumFormBridge\setAutoSort().
Here is the call graph for this function:
◆ update()
| ilAdvancedMDFieldDefinitionSelectMulti::update | ( | ) |
Update field entry.
Reimplemented from ilAdvancedMDFieldDefinitionSelect.
Definition at line 112 of file class.ilAdvancedMDFieldDefinitionSelectMulti.php.
113 {
114 if(sizeof($this->confirmed_objects))
115 {
116 // we need the "old" options for the search
117 $def = $this->getADTDefinition();
118 $def = clone($def);
119 $def->setOptions(array_combine($this->old_options, $this->old_options));
120 $search = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($def, false, false);
122
123 foreach($this->confirmed_objects as $old_option => $item_ids)
124 {
125 // get complete old values
126 $old_values = array();
128 {
129 $old_values[$item[0]."_".$item[1]."_".$item[2]] = $item[3];
130 }
131
132 foreach($item_ids as $item => $new_option)
133 {
134 $parts = explode("_", $item);
135 $obj_id = $parts[0];
136 $sub_type = $parts[1];
137 $sub_id = $parts[2];
138
139 if(!$new_option)
140 {
141 // remove existing value
142 $primary = array(
143 "obj_id" => array("integer", $obj_id),
144 "sub_type" => array("text", $sub_type),
145 "sub_id" => array("integer", $sub_id),
147 );
149 }
150 else
151 {
152 // update existing value (with changed option)
153 if(isset($old_values[$item]))
154 {
155 // find changed option in old value
156 $old_value = explode(ilADTMultiEnumDBBridge::SEPARATOR, $old_values[$item]);
157 // remove separators
158 array_shift($old_value);
159 array_pop($old_value);
160 $old_idx = array_keys($old_value, $old_option);
161 if(sizeof($old_idx))
162 {
163 // switch option
164 $old_idx = array_pop($old_idx);
165 $old_value[$old_idx] = $new_option;
166 $new_value = array_unique($old_value);
167 // add separators
168 $new_value = ilADTMultiEnumDBBridge::SEPARATOR.
169 implode(ilADTMultiEnumDBBridge::SEPARATOR, $new_value).
171
172 $primary = array(
173 "obj_id" => array("integer", $obj_id),
174 "sub_type" => array("text", $sub_type),
175 "sub_id" => array("integer", $sub_id),
177 );
179 }
180 }
181 }
182
183 if($sub_type == "wpg")
184 {
185 // #15763 - adapt advmd page lists
186 include_once "Modules/Wiki/classes/class.ilPCAMDPageList.php";
188 }
189 }
190 }
191
192 $this->confirmed_objects = array();
193 }
194
195 parent::update();
196 }
static writeByPrimary($a_table, array $a_primary, $a_type, $a_value)
Write directly.
Definition: class.ilADTActiveRecordByType.php:681
static deleteByPrimary($a_table, array $a_primary, $a_type=null)
Delete values by (partial) primary key.
Definition: class.ilADTActiveRecordByType.php:436
static migrateField($a_obj_id, $a_field_id, $old_option, $new_option, $a_is_multi=false)
Migrate search/filter values on advmd change.
Definition: class.ilPCAMDPageList.php:282
References ilADTActiveRecordByType\deleteByPrimary(), findBySingleValue(), ilAdvancedMDFieldDefinition\getADTDefinition(), ilAdvancedMDFieldDefinition\getFieldId(), ilADTFactory\getInstance(), ilADTFactory\initActiveRecordByType(), ilPCAMDPageList\migrateField(), ilADTMultiEnumDBBridge\SEPARATOR, and ilADTActiveRecordByType\writeByPrimary().
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.
Referenced by getValueForXML().
The documentation for this class was generated from the following file:
- Services/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionSelectMulti.php
