ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
|
AMD field type text. More...
Public Member Functions | |||||||
getType () | |||||||
Get type. More... | |||||||
getADTGroup () | |||||||
getTitles () | |||||||
hasComplexOptions () | |||||||
isMultilingualValueSupport () | |||||||
setMultilingualValueSupport (bool $multilingual_value_support) | |||||||
setMaxLength (?int $max_length) | |||||||
getMaxLength () | |||||||
setMulti (bool $a_value) | |||||||
isMulti () | |||||||
getFieldDefinitionForTableGUI (string $content_language) | |||||||
Parse properties for table gui. More... | |||||||
importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='') | |||||||
Import custom post values from definition form. More... | |||||||
importXMLProperty (string $a_key, string $a_value) | |||||||
Import property from XML. More... | |||||||
importValueFromXML (string $a_cdata) | |||||||
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... | |||||||
searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, string $a_locate, string $a_search_type) | |||||||
Search objects. More... | |||||||
![]() | |||||||
setOptions (?array $a_values=null) | |||||||
getOptions () | |||||||
getFieldDefinitionForTableGUI (string $content_language) | |||||||
Parse properties for table gui. More... | |||||||
importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='') | |||||||
Import custom post values from definition form. 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... | |||||||
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) | |||||||
![]() | |||||||
__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) | |||||||
Data Fields | |
const | XML_SEPARATOR_TRANSLATIONS = "~|~" |
const | XML_SEPARATOR_TRANSLATION = '~+~' |
const | KEY_MULTI = "multi" |
![]() | |
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 |
Protected Member Functions | |
initADTDefinition () | |
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 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... | |
![]() | |
initADTDefinition () | |
Init 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... | |
getADTForOption (string $a_option) | |
importComplexOptionFromForm (string $a_option, ilADT $a_adt) | |
findOptionById (string $a_id) | |
![]() | |
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 | |
int | $max_length = null |
bool | $multi = false |
bool | $multilingual_value_support = true |
![]() | |
$options = [] | |
$complex = [] | |
![]() | |
GenericData | $generic_data |
ilADTDefinition | $adt_def = null |
ilADT | $adt = null |
string | $language = '' |
ilDBInterface | $db |
ilLanguage | $lng |
ilLogger | $logger |
GlobalHttpState | $http |
RefineryFactory | $refinery |
Additional Inherited Members | |
![]() | |
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) |
![]() | |
static | getInstanceWithData (GenericData $generic_data, string $language='') |
static | getTypeString (int $a_type) |
Get type as string. More... | |
AMD field type text.
Definition at line 26 of file class.ilAdvancedMDFieldDefinitionText.php.
|
protected |
Add input elements to definition form.
ilPropertyFormGUI | $a_form | |
bool | $a_disabled | |
string | $language |
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 154 of file class.ilAdvancedMDFieldDefinitionText.php.
|
protected |
Add (type-specific) properties to xml export.
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 212 of file class.ilAdvancedMDFieldDefinitionText.php.
References ilXmlWriter\xmlElement().
ilAdvancedMDFieldDefinitionText::getADTGroup | ( | ) |
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 46 of file class.ilAdvancedMDFieldDefinitionText.php.
References ilAdvancedMDFieldDefinition\getADTDefinition().
|
protected |
Get (type-specific) field definition.
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 121 of file class.ilAdvancedMDFieldDefinitionText.php.
References getMaxLength(), isMulti(), and isMultilingualValueSupport().
ilAdvancedMDFieldDefinitionText::getFieldDefinitionForTableGUI | ( | string | $content_language | ) |
Parse properties for table gui.
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 130 of file class.ilAdvancedMDFieldDefinitionText.php.
References $DIC, ilAdvancedMDFieldDefinition\$lng, $res, getMaxLength(), isMulti(), and ilLanguage\txt().
ilAdvancedMDFieldDefinitionText::getMaxLength | ( | ) |
Definition at line 93 of file class.ilAdvancedMDFieldDefinitionText.php.
References $max_length.
Referenced by getFieldDefinition(), getFieldDefinitionForTableGUI(), and initADTDefinition().
ilAdvancedMDFieldDefinitionText::getSearchQueryParserValue | ( | ilADTSearchBridge | $a_adt_search | ) |
Get value for search query parser.
ilADTSearchBridge | $a_adt_search |
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 309 of file class.ilAdvancedMDFieldDefinitionText.php.
ilAdvancedMDFieldDefinitionText::getTitles | ( | ) |
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 51 of file class.ilAdvancedMDFieldDefinitionText.php.
ilAdvancedMDFieldDefinitionText::getType | ( | ) |
Get type.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 41 of file class.ilAdvancedMDFieldDefinitionText.php.
References ilAdvancedMDFieldDefinition\TYPE_TEXT.
ilAdvancedMDFieldDefinitionText::hasComplexOptions | ( | ) |
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 56 of file class.ilAdvancedMDFieldDefinitionText.php.
ilAdvancedMDFieldDefinitionText::importCustomDefinitionFormPostValues | ( | ilPropertyFormGUI | $a_form, |
string | $language = '' |
||
) |
Import custom post values from definition form.
ilPropertyFormGUI | $a_form | |
string | $language |
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 200 of file class.ilAdvancedMDFieldDefinitionText.php.
References ilPropertyFormGUI\getInput().
|
protected |
Import (type-specific) field definition from DB.
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 113 of file class.ilAdvancedMDFieldDefinitionText.php.
References setMaxLength(), setMulti(), and setMultilingualValueSupport().
ilAdvancedMDFieldDefinitionText::importFromECS | ( | string | $a_ecs_type, |
$a_value, | |||
string | $a_sub_id | ||
) |
Import meta data from ECS.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 270 of file class.ilAdvancedMDFieldDefinitionText.php.
References ILIAS\Repository\int(), ilECSUtils\TYPE_ARRAY, ilECSUtils\TYPE_INT, ilECSUtils\TYPE_STRING, and ilECSUtils\TYPE_TIMEPLACE.
ilAdvancedMDFieldDefinitionText::importValueFromXML | ( | string | $a_cdata | ) |
string | $a_cdata |
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 250 of file class.ilAdvancedMDFieldDefinitionText.php.
References $parts, and ilAdvancedMDRecord\_getInstanceByRecordId().
ilAdvancedMDFieldDefinitionText::importXMLProperty | ( | string | $a_key, |
string | $a_value | ||
) |
Import property from XML.
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 219 of file class.ilAdvancedMDFieldDefinitionText.php.
|
protected |
Exception |
Reimplemented from ilAdvancedMDFieldDefinitionGroupBased.
Definition at line 65 of file class.ilAdvancedMDFieldDefinitionText.php.
References ilADTFactory\getInstance(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), getMaxLength(), ilAdvancedMDFieldDefinition\getRecordId(), isMultilingualValueSupport(), and ilADTFactory\TYPE_LOCALIZED_TEXT.
ilAdvancedMDFieldDefinitionText::isMulti | ( | ) |
Definition at line 103 of file class.ilAdvancedMDFieldDefinitionText.php.
References $multi.
Referenced by getFieldDefinition(), and getFieldDefinitionForTableGUI().
ilAdvancedMDFieldDefinitionText::isMultilingualValueSupport | ( | ) |
Definition at line 78 of file class.ilAdvancedMDFieldDefinitionText.php.
References $multilingual_value_support.
Referenced by getFieldDefinition(), and initADTDefinition().
|
protected |
Add object-data needed for global search to AMD search results.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 314 of file class.ilAdvancedMDFieldDefinitionText.php.
ilAdvancedMDFieldDefinitionText::prepareElementForEditor | ( | ilADTFormBridge | $a_bridge | ) |
Prepare editor form elements.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 300 of file class.ilAdvancedMDFieldDefinitionText.php.
References ILIAS\Repository\logger().
ilAdvancedMDFieldDefinitionText::searchObjects | ( | ilADTSearchBridge | $a_adt_search, |
ilQueryParser | $a_parser, | ||
array | $a_object_types, | ||
string | $a_locate, | ||
string | $a_search_type | ||
) |
Search objects.
Reimplemented from ilAdvancedMDFieldDefinition.
Definition at line 348 of file class.ilAdvancedMDFieldDefinitionText.php.
References ilADTActiveRecordByType\find().
ilAdvancedMDFieldDefinitionText::setMaxLength | ( | ?int | $max_length | ) |
Definition at line 88 of file class.ilAdvancedMDFieldDefinitionText.php.
References $max_length.
Referenced by importFieldDefinition().
ilAdvancedMDFieldDefinitionText::setMulti | ( | bool | $a_value | ) |
Definition at line 98 of file class.ilAdvancedMDFieldDefinitionText.php.
Referenced by importFieldDefinition().
ilAdvancedMDFieldDefinitionText::setMultilingualValueSupport | ( | bool | $multilingual_value_support | ) |
Definition at line 83 of file class.ilAdvancedMDFieldDefinitionText.php.
References $multilingual_value_support.
Referenced by importFieldDefinition().
|
protected |
Definition at line 32 of file class.ilAdvancedMDFieldDefinitionText.php.
Referenced by getMaxLength(), and setMaxLength().
|
protected |
Definition at line 33 of file class.ilAdvancedMDFieldDefinitionText.php.
Referenced by isMulti().
|
protected |
Definition at line 34 of file class.ilAdvancedMDFieldDefinitionText.php.
Referenced by isMultilingualValueSupport(), and setMultilingualValueSupport().
const ilAdvancedMDFieldDefinitionText::KEY_MULTI = "multi" |
Definition at line 30 of file class.ilAdvancedMDFieldDefinitionText.php.
const ilAdvancedMDFieldDefinitionText::XML_SEPARATOR_TRANSLATION = '~+~' |
Definition at line 29 of file class.ilAdvancedMDFieldDefinitionText.php.
const ilAdvancedMDFieldDefinitionText::XML_SEPARATOR_TRANSLATIONS = "~|~" |
Definition at line 28 of file class.ilAdvancedMDFieldDefinitionText.php.