|
ILIAS
trunk Revision v12.0_alpha-377-g3641b37b9db
|
AMD field type select. More...
Inheritance diagram for ilAdvancedMDFieldDefinitionSelect:
Collaboration diagram for ilAdvancedMDFieldDefinitionSelect:Public Member Functions | |
| __construct (GenericData $generic_data, string $language='') | |
| getType () | |
| Get type. More... | |
| getSearchQueryParserValue (ilADTSearchBridge $a_adt_search) | |
| Get value for search query parser. More... | |
| getOptionsInDefaultLanguageAsArray () | |
| 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 (bool $keep_pos_and_import_id=false, bool $keep_import_id=false) | |
| Create new field entry. More... | |
| update () | |
| Update field entry. More... | |
| importXMLProperty (string $a_key, string $a_value) | |
| Since the XML import only allows for a key-value pair, we also rely on the order of properties to sort translations into options. More... | |
| getValueForXML (ilADT $element) | |
| Parse ADT value for xml (export) More... | |
| importValueFromXML (string $a_cdata) | |
| Import value from xml. More... | |
| prepareElementForEditor (ilADTFormBridge $a_bridge) | |
| Prepare editor form elements. More... | |
Public Member Functions inherited from ilAdvancedMDFieldDefinition | |
| __construct (GenericData $generic_data, 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 $keep_pos_and_import_id=false, bool $keep_import_id=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 () | |
| Init adt instance. More... | |
| options () | |
| getOptionsInLanguageAsArray (string $language, bool $default_as_fallback=true) | |
| 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... | |
| addCreateOptionsFieldsToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled) | |
| addEditOptionsFieldsToDefinitionForm (SelectSpecificData $options, ilPropertyFormGUI $a_form, bool $a_disabled) | |
| addRadioToEntriesGroup (ilRadioGroupInputGUI $entries, array $position_select_options, ?int $position_value, string $label, string $value, string $id, bool $with_delete_checkbox, bool $disabled) | |
| Returns hidden inputs if a disabled checkbox is in the radio, such that we can use the workaround for having disabled checkboxes still write to post. 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 (ilADTSearchBridge $a_search, $a_value) | |
| importTranslatedFormPostValues (ilPropertyFormGUI $form, string $language) | |
| deleteOptions () | |
| updateOptions () | |
| saveOptions () | |
| addPropertiesToXML (ilXmlWriter $a_writer) | |
| Add (type-specific) properties to xml export. More... | |
| translateLegacyImportValueFromXML (string $value) | |
| On import from <7 options are not given by index but by their label. More... | |
| readOptions () | |
Protected Member Functions inherited from ilAdvancedMDFieldDefinition | |
| initADTDefinition () | |
| Init adt instance. More... | |
| setADT (ilADT $a_adt) | |
| Set ADT instance. 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... | |
| 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 | |
| array | $confirm_objects = [] |
| array | $confirm_objects_values = [] |
| array | $confirmed_objects = null |
| array | $old_options_array = null |
| SelectSpecificData | $options |
| string | $default_language |
Protected Attributes inherited from ilAdvancedMDFieldDefinition | |
| GenericData | $generic_data |
| ilADTDefinition | $adt_def = null |
| ilADT | $adt = null |
| string | $language = '' |
| ilDBInterface | $db |
| ilLanguage | $lng |
| ilLogger | $logger |
| GlobalHttpState | $http |
| RefineryFactory | $refinery |
Private Attributes | |
| const | REMOVE_ACTION_ID = "-iladvmdrm-" |
| const | ADD_NEW_ENTRY_ID = "-advmd_add_new_entry-" |
| ilGlobalTemplateInterface | $main_tpl |
| Gateway | $db_gateway |
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 |
| TODO: put this in when minimum php version is set to 8.2. More... | |
| 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 | getInstanceWithData (GenericData $generic_data, string $language='') |
| static | getTypeString (int $a_type) |
| Get type as string. More... | |
AMD field type select.
Definition at line 32 of file class.ilAdvancedMDFieldDefinitionSelect.php.
| ilAdvancedMDFieldDefinitionSelect::__construct | ( | GenericData | $generic_data, |
| string | $language = '' |
||
| ) |
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 49 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References $DIC, ilAdvancedMDFieldDefinition\$generic_data, ilAdvancedMDFieldDefinition\$language, ILIAS\GlobalScreen\Provider\__construct(), and readOptions().
Here is the call graph for this function:
|
protected |
Definition at line 153 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Add custom input elements to definition form.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 135 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 292 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References $text, ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().
Here is the call graph for this function:
|
protected |
Definition at line 166 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ILIAS\Repository\lng().
Here is the call graph for this function:
|
protected |
Add (type-specific) properties to xml export.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 800 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ILIAS\UI\Implementation\Component\Input\Field\getOptions(), and ilXmlWriter\xmlElement().
Here is the call graph for this function:
|
protected |
Returns hidden inputs if a disabled checkbox is in the radio, such that we can use the workaround for having disabled checkboxes still write to post.
Definition at line 232 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Process custom post values from definition form.
Definition at line 331 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References $parts, $res, and ilPropertyFormGUI\getInput().
Here is the call graph for this function:| ilAdvancedMDFieldDefinitionSelect::delete | ( | ) |
Delete field entry.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 691 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 703 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
| ilADTEnumSearchBridgeMulti | $a_search | |
| $a_value |
Definition at line 511 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References $res, ilADTActiveRecordByType\find(), and ilADTSearchBridge\getSQLCondition().
Here is the call graph for this function:
|
protected |
Get (type-specific) field definition.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 118 of file class.ilAdvancedMDFieldDefinitionSelect.php.
| ilAdvancedMDFieldDefinitionSelect::getFieldDefinitionForTableGUI | ( | string | $content_language | ) |
Parse properties for table gui.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 123 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ILIAS\UI\Implementation\Component\Input\Field\$options, and ILIAS\Repository\lng().
Here is the call graph for this function:| ilAdvancedMDFieldDefinitionSelect::getOptionsInDefaultLanguageAsArray | ( | ) |
Definition at line 85 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ILIAS\UI\Implementation\Component\Input\Field\getOptions(), and options().
Here is the call graph for this function:
|
protected |
Definition at line 96 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilAdvancedMDFieldDefinition\$language.
Referenced by initADTDefinition(), and ilAdvancedMDFieldDefinitionSelectMulti\initADTDefinition().
Here is the caller graph for this function:| ilAdvancedMDFieldDefinitionSelect::getSearchQueryParserValue | ( | ilADTSearchBridge | $a_adt_search | ) |
Get value for search query parser.
| ilADTSearchBridge | $a_adt_search |
Reimplemented from ilAdvancedMDFieldDefinition.
Reimplemented in ilAdvancedMDFieldDefinitionSelectMulti.
Definition at line 66 of file class.ilAdvancedMDFieldDefinitionSelect.php.
| ilAdvancedMDFieldDefinitionSelect::getType | ( | ) |
Get type.
Reimplemented from ilAdvancedMDFieldDefinition.
Reimplemented in ilAdvancedMDFieldDefinitionSelectMulti.
Definition at line 61 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilAdvancedMDFieldDefinition\TYPE_SELECT.
| ilAdvancedMDFieldDefinitionSelect::getValueForXML | ( | ilADT | $element | ) |
Parse ADT value for xml (export)
Options of imported local fields don't keep their ID, but get assigned a new ID based on order. To conserve assigments, the same logic has to be applied here.
Reimplemented from ilAdvancedMDFieldDefinition.
Reimplemented in ilAdvancedMDFieldDefinitionSelectMulti.
Definition at line 844 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilAdvancedMDRecord\_getInstanceByRecordId(), and ILIAS\UI\Implementation\Component\Input\Field\getOptions().
Here is the call graph for this function:| ilAdvancedMDFieldDefinitionSelect::importCustomDefinitionFormPostValues | ( | ilPropertyFormGUI | $a_form, |
| string | $language = '' |
||
| ) |
Import custom post values from definition form.
Reimplemented from ilAdvancedMDFieldDefinition.
Reimplemented in ilAdvancedMDFieldDefinitionSelectMulti.
Definition at line 385 of file class.ilAdvancedMDFieldDefinitionSelect.php.
| ilAdvancedMDFieldDefinitionSelect::importDefinitionFormPostValuesNeedsConfirmation | ( | ) |
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 546 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Import (type-specific) field definition from DB.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 114 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 390 of file class.ilAdvancedMDFieldDefinitionSelect.php.
Referenced by ilAdvancedMDFieldDefinitionSelectMulti\importCustomDefinitionFormPostValues().
Here is the caller graph for this function:
|
protected |
Definition at line 531 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilPropertyFormGUI\getInput(), and ILIAS\UI\Implementation\Component\Input\Field\getOptions().
Here is the call graph for this function:| ilAdvancedMDFieldDefinitionSelect::importValueFromXML | ( | string | $a_cdata | ) |
Import value from xml.
| string | $a_cdata |
Reimplemented from ilAdvancedMDFieldDefinition.
Reimplemented in ilAdvancedMDFieldDefinitionSelectMulti.
Definition at line 865 of file class.ilAdvancedMDFieldDefinitionSelect.php.
| ilAdvancedMDFieldDefinitionSelect::importXMLProperty | ( | string | $a_key, |
| string | $a_value | ||
| ) |
Since the XML import only allows for a key-value pair, we also rely on the order of properties to sort translations into options.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 817 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilAdvancedMDRecord\_getInstanceByRecordId(), and ILIAS\UI\Implementation\Component\Input\Field\getOptions().
Here is the call graph for this function:
|
protected |
Init adt instance.
Reimplemented from ilAdvancedMDFieldDefinition.
Reimplemented in ilAdvancedMDFieldDefinitionSelectMulti.
Definition at line 71 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilADTFactory\getInstance(), getOptionsInLanguageAsArray(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().
Here is the call graph for this function:
|
protected |
Definition at line 80 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References $options.
Referenced by getOptionsInDefaultLanguageAsArray(), and ilAdvancedMDFieldDefinitionSelectMulti\getValueForXML().
Here is the caller graph for this function:| ilAdvancedMDFieldDefinitionSelect::prepareCustomDefinitionFormConfirmation | ( | ilPropertyFormGUI | $a_form | ) |
@noinspection PhpUndefinedMethodInspection
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 550 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References $DIC, $lng, ILIAS\UI\Implementation\Component\Input\Field\$options, ilObject\_lookupTitle(), ilObject\_lookupType(), ilPropertyFormGUI\addItem(), ilPropertyFormGUI\getItemByPostVar(), ILIAS\UI\Implementation\Component\Input\Field\getOptions(), ILIAS\FileDelivery\http(), and ILIAS\Repository\int().
Here is the call graph for this function:| ilAdvancedMDFieldDefinitionSelect::prepareElementForEditor | ( | ilADTFormBridge | $a_bridge | ) |
Prepare editor form elements.
Reimplemented from ilAdvancedMDFieldDefinition.
Reimplemented in ilAdvancedMDFieldDefinitionSelectMulti.
Definition at line 896 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 903 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilAdvancedMDRecord\_getInstanceByRecordId().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:| ilAdvancedMDFieldDefinitionSelect::save | ( | bool | $keep_pos_and_import_id = false, |
| bool | $keep_import_id = false |
||
| ) |
Create new field entry.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 697 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 714 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ILIAS\UI\Implementation\Component\Input\Field\$options.
|
protected |
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 ilAdvancedMDFieldDefinitionGroupBased::importValueFromXML.
Definition at line 880 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References ilAdvancedMDRecord\_getInstanceByRecordId(), and ILIAS\UI\Implementation\Component\Input\Field\getOptions().
Referenced by ilAdvancedMDFieldDefinitionSelectMulti\importValueFromXML().
Here is the call graph for this function:
Here is the caller graph for this function:| ilAdvancedMDFieldDefinitionSelect::update | ( | ) |
Update field entry.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 723 of file class.ilAdvancedMDFieldDefinitionSelect.php.
References $parts, ilADTActiveRecordByType\create(), ilADTActiveRecordByType\deleteByPrimary(), ilADTFactory\getInstance(), ilADTFactory\initActiveRecordByType(), ILIAS\Repository\int(), ilPCAMDPageList\migrateField(), and ilDBConstants\T_INTEGER.
Here is the call graph for this function:
|
protected |
Definition at line 708 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 37 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 38 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 39 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
private |
Definition at line 47 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 43 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
private |
Definition at line 45 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 40 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
protected |
Definition at line 41 of file class.ilAdvancedMDFieldDefinitionSelect.php.
Referenced by options().
|
private |
Definition at line 35 of file class.ilAdvancedMDFieldDefinitionSelect.php.
|
private |
Definition at line 34 of file class.ilAdvancedMDFieldDefinitionSelect.php.