AMD field abstract base class. More...

Inheritance diagram for ilAdvancedMDFieldDefinition:

Collaboration diagram for ilAdvancedMDFieldDefinition:

Public Member Functions
	__construct (?int $a_field_id=null, 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 $a_keep_pos=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)

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

const	TYPE_ADDRESS = 99

const	TYPE_EXTERNAL_LINK = 9

const	TYPE_INTERNAL_LINK = 10

Protected Member Functions
	init ()

	initADTDefinition ()
	Init adt instance. More...

	setADT (ilADT $a_adt)
	Set ADT instance. More...

	setFieldId (int $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, bool $a_disabled=false, string $language='')
	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 (?int $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...

Static Protected Member Functions
static	getTypeString (int $a_type)
	Get type as string. More...

Protected Attributes
int	$field_id = null

int	$record_id = 0

string	$import_id = ''

int	$position = 0

string	$title = ''

string	$description = ''

bool	$searchable = false

bool	$required = false

ilADTDefinition	$adt_def = null

ilADT	$adt = null

string	$language = ''

ilDBInterface	$db

ilLanguage	$lng

ilLogger	$logger

GlobalHttpState	$http

RefineryFactory	$refinery

Detailed Description

AMD field abstract base class.

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 30 of file class.ilAdvancedMDFieldDefinition.php.

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDFieldDefinition::__construct	(	?int	$a_field_id = `null`,
		string	$language = `''`
	)

PhpUndefinedMethodInspection

Definition at line 63 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $language, ILIAS\FileDelivery\http(), init(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), read(), and ILIAS\Repository\refinery().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->language = $DIC->language()->getLangKey();
         $this->refinery = $DIC->refinery();
         $this->http = $DIC->http();
 
 
         if ($language) {
             $this->language = $language;
         }
         $this->logger = $DIC->logger()->amet();
         $this->db = $DIC->database();
 
         $this->init();
         $this->read($a_field_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _clone()

ilAdvancedMDFieldDefinition::_clone ( int $a_new_record_id )

Clone field definition.

Definition at line 1095 of file class.ilAdvancedMDFieldDefinition.php.

References getDescription(), getFieldDefinition(), getPosition(), getTitle(), isRequired(), and isSearchable().

Referenced by ilAdvancedMDFieldDefinitionSelect\import().

                                                 : self
     {
         $class = get_class($this);
         $obj = new $class();
         $obj->setRecordId($a_new_record_id);
         $obj->setTitle($this->getTitle());
         $obj->setDescription($this->getDescription());
         $obj->setRequired($this->isRequired());
         $obj->setPosition($this->getPosition());
         $obj->setSearchable($this->isSearchable());
         $obj->importFieldDefinition($this->getFieldDefinition());
         $obj->save(true);
 
         return $obj;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCustomFieldToDefinitionForm()

ilAdvancedMDFieldDefinition::addCustomFieldToDefinitionForm	(	ilPropertyFormGUI	$a_form,
		bool	$a_disabled = `false`,
		string	$language = `''`
	)

protected

Add custom input elements to definition form.

Definition at line 570 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by addToFieldDefinitionForm().

574 : void {

575 }

Here is the caller graph for this function:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinition::addPropertiesToXML ( ilXmlWriter $a_writer )

protected

Add (type-specific) properties to xml export.

Definition at line 928 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by toXML().

                                                                 : void
     {
         // type-specific properties
     }

Here is the caller graph for this function:

◆ addToFieldDefinitionForm()

ilAdvancedMDFieldDefinition::addToFieldDefinitionForm	(	ilPropertyFormGUI	$a_form,
		ilAdvancedMDPermissionHelper	$a_permissions,
		string	$language = `''`
	)

Add input elements to definition form.

Definition at line 580 of file class.ilAdvancedMDFieldDefinition.php.

References $check, $DIC, ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, addCustomFieldToDefinitionForm(), ilPropertyFormGUI\addItem(), ilAdvancedMDPermissionHelper\CONTEXT_FIELD, getDescription(), getFieldId(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), getRecordId(), getTitle(), ilClaimingPermissionHelper\hasPermissions(), isSearchable(), isSearchSupported(), ilTextAreaInputGUI\setValue(), ilAdvancedMDPermissionHelper\SUBACTION_FIELD_DESCRIPTION, ilAdvancedMDPermissionHelper\SUBACTION_FIELD_PROPERTIES, ilAdvancedMDPermissionHelper\SUBACTION_FIELD_SEARCHABLE, ilAdvancedMDPermissionHelper\SUBACTION_FIELD_TITLE, and ilLanguage\txt().

Referenced by ilAdvancedMDSettingsGUI\initFieldForm().

      : void {
         global $DIC;
         $lng = $DIC['lng'];
 
         $perm = $a_permissions->hasPermissions(
             ilAdvancedMDPermissionHelper::CONTEXT_FIELD,
             (string) $this->getFieldId(),
             array(
                 array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                       ilAdvancedMDPermissionHelper::SUBACTION_FIELD_TITLE
                 )
                 ,
                 array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                       ilAdvancedMDPermissionHelper::SUBACTION_FIELD_DESCRIPTION
                 )
                 ,
                 array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                       ilAdvancedMDPermissionHelper::SUBACTION_FIELD_SEARCHABLE
                 )
                 ,
                 array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                       ilAdvancedMDPermissionHelper::SUBACTION_FIELD_PROPERTIES
                 )
             )
         );
 
         // title
         $translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($this->getRecordId());
 
         $title = new ilTextInputGUI($lng->txt('title'), 'title');
         $title->setValue($this->getTitle());
         $title->setSize(20);
         $title->setMaxLength(70);
         $title->setRequired(true);
         if ($this->getFieldId()) {
             $translations->modifyTranslationInfoForTitle($this->getFieldId(), $a_form, $title, $language);
         } else {
             $title->setValue($this->getTitle());
         }
 
         $a_form->addItem($title);
 
         if (!$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_TITLE]) {
             $title->setDisabled(true);
         }
 
         // desc
         $desc = new ilTextAreaInputGUI($lng->txt('description'), 'description');
         $desc->setValue($this->getDescription());
         $desc->setRows(3);
         $desc->setCols(50);
         if ($this->getFieldId()) {
             $translations->modifyTranslationInfoForDescription($this->getFieldId(), $a_form, $desc, $language);
         } else {
             $desc->setValue($this->getDescription());
         }
 
         $a_form->addItem($desc);
 
         if (!$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_DESCRIPTION]) {
             $desc->setDisabled(true);
         }
 
         // searchable
         $check = new ilCheckboxInputGUI($lng->txt('md_adv_searchable'), 'searchable');
         $check->setChecked($this->isSearchable());
         $check->setValue("1");
         $a_form->addItem($check);
 
         if (!$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_SEARCHABLE] ||
             !$this->isSearchSupported()) {
             $check->setDisabled(true);
         }
 
         /* required
         $check = new ilCheckboxInputGUI($lng->txt('md_adv_required'), 'required');
         $check->setChecked($this->isRequired());
         $check->setValue(1);
         $a_form->addItem($check);
         */
 
         $this->addCustomFieldToDefinitionForm(
             $a_form,
             !$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_PROPERTIES],
             $language
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilAdvancedMDFieldDefinition::delete ( )

Delete field entry.

Definition at line 871 of file class.ilAdvancedMDFieldDefinition.php.

References $query, ilAdvancedMDValues\_deleteByFieldId(), getADT(), and getFieldId().

                             : void
     {
         if (!$this->getFieldId()) {
             return;
         }
 
         // delete all values
         ilAdvancedMDValues::_deleteByFieldId($this->getFieldId(), $this->getADT());
 
         $query = "DELETE FROM adv_mdf_definition" .
             " WHERE field_id = " . $this->db->quote($this->getFieldId(), "integer");
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ exists()

static ilAdvancedMDFieldDefinition::exists ( int $a_field_id )

static

Definition at line 108 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilContainerFilterFieldData\getFilterSetForRefId().

                                                   : bool
     {
         global $DIC;
 
         $db = $DIC['ilDB'];
         $set = $db->query("SELECT field_type" .
             " FROM adv_mdf_definition" .
             " WHERE field_id = " . $db->quote($a_field_id, "integer"));
         if ($db->fetchAssoc($set)) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateImportId()

ilAdvancedMDFieldDefinition::generateImportId ( int $a_field_id )

Generate unique record id.

Definition at line 754 of file class.ilAdvancedMDFieldDefinition.php.

References IL_INST_ID.

Referenced by save(), and toXML().

                                                      : string
     {
         return 'il_' . IL_INST_ID . '_adv_md_field_' . $a_field_id;
     }

Here is the caller graph for this function:

◆ getADT()

ilAdvancedMDFieldDefinition::getADT ( )

Definition at line 368 of file class.ilAdvancedMDFieldDefinition.php.

References $adt, getADTDefinition(), and ilADTFactory\getInstance().

                             : ilADT
     {
         if (!$this->adt instanceof ilADT) {
             $this->adt = ilADTFactory::getInstance()->getInstanceByDefinition($this->getADTDefinition());
         }
         return $this->adt;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getADTDefinition()

ilAdvancedMDFieldDefinition::getADTDefinition ( )

Get ADT definition instance.

Returns: ilADTDefinition

Definition at line 360 of file class.ilAdvancedMDFieldDefinition.php.

References $adt_def, and initADTDefinition().

Referenced by getADT(), ilAdvancedMDFieldDefinitionText\getADTGroup(), ilAdvancedMDFieldDefinitionSelect\importNewSelectOptions(), and ilAdvancedMDFieldDefinitionSelect\update().

                                       : ilADTDefinition
     {
         if (!$this->adt_def instanceof ilADTDefinition) {
             $this->adt_def = $this->initADTDefinition();
         }
         return $this->adt_def;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getADTGroupForDefinitions()

static ilAdvancedMDFieldDefinition::getADTGroupForDefinitions ( array $a_defs )

static

Init ADTGroup for definitions.

Parameters

array<int,ilADTDefinition>

Returns: ilADTGroup

Todo:: check return type array<string, ilADTDefinition> or array<string, ilADTDefinition>

Definition at line 254 of file class.ilAdvancedMDFieldDefinition.php.

References $factory, and ilADTFactory\getInstance().

Referenced by ilAdvancedMDValues\getADTGroup(), and ilAdvancedMDValues\queryForRecords().

                                                                    : ilADT
     {
         $factory = ilADTFactory::getInstance();
         $group_def = $factory->getDefinitionInstanceByType("Group");
         foreach ($a_defs as $def) {
             $group_def->addElement($def->getFieldId(), $def->getADTDefinition());
         }
         $group = $factory->getInstanceByDefinition($group_def);
 
         // bind adt instances to definition
         foreach ($group->getElements() as $element_id => $element) {
             $a_defs[$element_id]->setADT($element);
         }
         return $group;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComplexOptionsOverview()

ilAdvancedMDFieldDefinition::getComplexOptionsOverview	(	object	$a_parent_gui,
		string	$parent_cmd
	)

Parameters

object	$a_parent_gui
string	$parent_cmd

Returns: null

Definition at line 1124 of file class.ilAdvancedMDFieldDefinition.php.

                                                                                        : ?string
     {
         return null;
     }

◆ getDBProperties()

ilAdvancedMDFieldDefinition::getDBProperties ( )

protected

Get all definition properties for DB.

Definition at line 762 of file class.ilAdvancedMDFieldDefinition.php.

References getDescription(), getFieldDefinition(), getImportId(), getPosition(), getRecordId(), getTitle(), getType(), isRequired(), and isSearchable().

Referenced by save(), and update().

                                         : array
     {
         $fields = array(
             "field_type" => array("integer", $this->getType()),
             "record_id" => array("integer", $this->getRecordId()),
             "import_id" => array("text", $this->getImportId()),
             "title" => array("text", $this->getTitle()),
             "description" => array("text", $this->getDescription()),
             "position" => array("integer", $this->getPosition()),
             "searchable" => array("integer", $this->isSearchable()),
             "required" => array("integer", $this->isRequired())
         );
 
         $def = $this->getFieldDefinition();
         if (is_array($def)) {
             $fields["field_values"] = array("text", serialize($def));
         }
         return $fields;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilAdvancedMDFieldDefinition::getDescription ( )

Get description.

Definition at line 487 of file class.ilAdvancedMDFieldDefinition.php.

References $description.

Referenced by _clone(), addToFieldDefinitionForm(), getDBProperties(), ilAdvancedMDSettingsGUI\initFieldForm(), and toXML().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinition::getFieldDefinition ( )

protected

Get (type-specific) field definition.

Definition at line 554 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by _clone(), and getDBProperties().

Here is the caller graph for this function:

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinition::getFieldDefinitionForTableGUI ( string $content_language )

Parse properties for table gui.

Definition at line 562 of file class.ilAdvancedMDFieldDefinition.php.

◆ getFieldId()

ilAdvancedMDFieldDefinition::getFieldId ( )

Get field_id.

Definition at line 398 of file class.ilAdvancedMDFieldDefinition.php.

References $field_id.

                                 : ?int
     {
         return $this->field_id;
     }

Here is the caller graph for this function:

◆ getImportId()

ilAdvancedMDFieldDefinition::getImportId ( )

Get import id.

Definition at line 433 of file class.ilAdvancedMDFieldDefinition.php.

References $import_id.

Referenced by getDBProperties(), and save().

                                  : string
     {
         return $this->import_id;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilAdvancedMDFieldDefinition::getInstance	(	?int	$a_field_id,
		?int	$a_type = `null`,
		string	$language = `''`
	)

static

Definition at line 84 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, ilDBInterface\fetchAssoc(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

      : ilAdvancedMDFieldDefinition {
         global $DIC;
 
         $db = $DIC->database();
 
         if (!$a_type) {
             $set = $db->query("SELECT field_type" .
                 " FROM adv_mdf_definition" .
                 " WHERE field_id = " . $db->quote($a_field_id, "integer"));
             $a_type = $db->fetchAssoc($set);
             $a_type = (int) $a_type["field_type"];
         }
 
         if (self::isValidType($a_type)) {
             $class = "ilAdvancedMDFieldDefinition" . self::getTypeString($a_type);
             return new $class($a_field_id, $language);
         }
         throw new ilException("unknown type " . $a_type);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceByImportId()

static ilAdvancedMDFieldDefinition::getInstanceByImportId ( string $a_import_id )

static

Definition at line 209 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, and $query.

Referenced by ilAdvancedMDParser\initValue().

                                                                      : ?ilAdvancedMDFieldDefinition
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT field_id, field_type FROM adv_mdf_definition" .
             " WHERE import_id = " . $ilDB->quote($a_import_id, 'text');
         $set = $ilDB->query($query);
         if ($ilDB->numRows($set)) {
             $row = $ilDB->fetchAssoc($set);
             return self::getInstance((int) $row["field_id"], (int) $row["field_type"]);
         }
         return null;
     }

Here is the caller graph for this function:

◆ getInstanceByTypeString()

static ilAdvancedMDFieldDefinition::getInstanceByTypeString ( string $a_type )

static

Get instance by type string (used by import)

Definition at line 125 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilAdvancedMDRecordParser\initFieldObject().

                                                                   : ?ilAdvancedMDFieldDefinition
     {
         // see self::getTypeString()
         $map = array(
             self::TYPE_TEXT => "Text",
             self::TYPE_SELECT => "Select",
             self::TYPE_DATE => "Date",
             self::TYPE_DATETIME => "DateTime",
             self::TYPE_FLOAT => "Float",
             self::TYPE_LOCATION => "Location",
             self::TYPE_INTEGER => "Integer",
             self::TYPE_SELECT_MULTI => "SelectMulti",
             self::TYPE_EXTERNAL_LINK => 'ExternalLink',
             self::TYPE_INTERNAL_LINK => 'InternalLink',
             self::TYPE_ADDRESS => "Address"
         );
         $map = array_flip($map);
         if (array_key_exists($a_type, $map)) {
             return self::getInstance(null, $map[$a_type]);
         }
         return null;
     }

Here is the caller graph for this function:

◆ getInstancesByObjType()

static ilAdvancedMDFieldDefinition::getInstancesByObjType	(	$a_obj_type,
		$a_active_only = `true`
	)

static

Parameters

string	$a_obj_type
bool	$a_active_only

Returns: array<int, ilAdvancedMDFieldDefinition>

Definition at line 185 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, $query, $res, and ILIAS\Repository\int().

Referenced by ilECSSettingsGUI\exportMappings(), ilECSSettingsGUI\importMappings(), ilAdvancedMDSettingsGUI\initFormSubstitutions(), ilECSSettingsGUI\initMappingsForm(), ilAdvancedMDRecordGUI\parseAppointmentPresentationa(), and ilAdvancedMDSettingsGUI\updateSubstitutions().

                                                                                     : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT amf.* FROM adv_md_record_objs aro" .
             " JOIN adv_md_record amr ON aro.record_id = amr.record_id" .
             " JOIN adv_mdf_definition amf ON aro.record_id = amf.record_id" .
             " WHERE obj_type = " . $ilDB->quote($a_obj_type, 'text');
         if ($a_active_only) {
             $query .= " AND active = " . $ilDB->quote(1, "integer");
         }
         $query .= " ORDER BY aro.record_id,position";
         $res = $ilDB->query($query);
         $defs = [];
         while ($row = $ilDB->fetchAssoc($res)) {
             $field = self::getInstance(null, (int) $row["field_type"]);
             $field->import($row);
             $defs[(int) $row["field_id"]] = $field;
         }
         return $defs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstancesByRecordId()

static ilAdvancedMDFieldDefinition::getInstancesByRecordId	(		$a_record_id,
			$a_only_searchable = `false`,
		string	$language = `''`
	)

static

Get definitions by record id.

Parameters

int	$a_record_id
bool	$a_only_searchable
string	$language

Returns: array<int, ilAdvancedMDFieldDefinition>

Definition at line 155 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, $query, and ILIAS\Repository\int().

Referenced by ilAdvancedMDRecord\_clone(), ilGlossaryTerm\_copyTerm(), ilAdvancedMDRecord\_delete(), ilAdvancedMDSettingsGUI\editFields(), ilAdvancedMDRecordTableGUI\fillRow(), ilObjBookingPool\getAdvancedMDFields(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilContainerFilterAdvMDAdapter\getAvailableRecordSets(), ilAdvancedMDValues\getDefinitions(), ilLuceneAdvancedSearchFields\getFields(), ilPCAMDPageList\handleCopiedContent(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDRecordGUI\parseTableCells(), ilAdvancedMDRecordGUI\parseTableHead(), ilAdvancedMDValues\queryForRecords(), ilAdvancedMDFieldTranslations\read(), ilAdvancedMDRecord\toXML(), and ilAdvancedMDSettingsGUI\updateFields().

      : array {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM adv_mdf_definition" .
             " WHERE record_id = " . $ilDB->quote($a_record_id, "integer");
         if ($a_only_searchable) {
             $query .= " AND searchable = " . $ilDB->quote(1, "integer");
         }
         $query .= " ORDER BY position";
         $set = $ilDB->query($query);
         $defs = [];
         while ($row = $ilDB->fetchAssoc($set)) {
             $field = self::getInstance(null, (int) $row["field_type"], $language);
             $field->import($row);
             $defs[(int) $row["field_id"]] = $field;
         }
         return $defs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastPosition()

ilAdvancedMDFieldDefinition::getLastPosition ( )

protected

Get last position of record.

Definition at line 738 of file class.ilAdvancedMDFieldDefinition.php.

References getRecordId().

Referenced by save().

                                         : int
     {
         $sql = "SELECT max(position) pos" .
             " FROM adv_mdf_definition" .
             " WHERE record_id = " . $this->db->quote($this->getRecordId(), "integer");
         $set = $this->db->query($sql);
         if ($this->db->numRows($set)) {
             $pos = $this->db->fetchAssoc($set);
             return (int) $pos["pos"];
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLuceneSearchString()

ilAdvancedMDFieldDefinition::getLuceneSearchString ( $a_value )

Get search string in lucene syntax.

Parameters

string | array

Returns

Todo:: with php 8 support change parameter to union type

Definition at line 1080 of file class.ilAdvancedMDFieldDefinition.php.

     {
         return $a_value;
     }

◆ getPosition()

ilAdvancedMDFieldDefinition::getPosition ( )

Get position.

Definition at line 449 of file class.ilAdvancedMDFieldDefinition.php.

References $position.

Referenced by _clone(), getDBProperties(), and toXML().

                                  : int
     {
         return $this->position;
     }

Here is the caller graph for this function:

◆ getRecordId()

ilAdvancedMDFieldDefinition::getRecordId ( )

Get record id.

Definition at line 414 of file class.ilAdvancedMDFieldDefinition.php.

References $record_id.

Referenced by addToFieldDefinitionForm(), getDBProperties(), getLastPosition(), ilAdvancedMDFieldDefinitionSelect\import(), ilAdvancedMDFieldDefinitionSelect\importNewSelectOptions(), ilAdvancedMDFieldDefinitionText\initADTDefinition(), and toXML().

                                  : int
     {
         return $this->record_id;
     }

Here is the caller graph for this function:

◆ getSearchableDefinitionIds()

static ilAdvancedMDFieldDefinition::getSearchableDefinitionIds ( )

static

Get searchable definition ids (performance is key)

Returns: int[]

Definition at line 229 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, $query, and ILIAS\Repository\int().

Referenced by ilAdvancedSearchGUI\setSubTabs().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $field_ids = array();
 
         $query = "SELECT field_id FROM adv_md_record amr" .
             " JOIN adv_mdf_definition amfd ON (amr.record_id = amfd.record_id)" .
             " WHERE active = " . $ilDB->quote(1, "integer") .
             " AND searchable = " . $ilDB->quote(1, "integer");
         $set = $ilDB->query($query);
         while ($row = $ilDB->fetchAssoc($set)) {
             $field_ids[] = (int) $row["field_id"];
         }
         return $field_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSearchQueryParserValue()

ilAdvancedMDFieldDefinition::getSearchQueryParserValue ( ilADTSearchBridge $a_adt_search )

Get value for search query parser.

Parameters

ilADTSearchBridge $a_adt_search

Returns: string

Todo:: check if string type is applicable

Definition at line 973 of file class.ilAdvancedMDFieldDefinition.php.

◆ getSearchValueSerialized()

ilAdvancedMDFieldDefinition::getSearchValueSerialized ( ilADTSearchBridge $a_adt_search )

Definition at line 978 of file class.ilAdvancedMDFieldDefinition.php.

References ilADTSearchBridge\getSerializedValue().

                                                                              : string
     {
         return $a_adt_search->getSerializedValue();
     }

Here is the call graph for this function:

◆ getTitle()

ilAdvancedMDFieldDefinition::getTitle ( )

Get title.

Definition at line 468 of file class.ilAdvancedMDFieldDefinition.php.

References $title.

Referenced by _clone(), addToFieldDefinitionForm(), getDBProperties(), and toXML().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getType()

ilAdvancedMDFieldDefinition::getType ( )

abstract

Get type.

Referenced by getDBProperties(), getTypeTitle(), isValidType(), searchObjects(), searchSubObjects(), and toXML().

Here is the caller graph for this function:

◆ getTypeString()

static ilAdvancedMDFieldDefinition::getTypeString ( int $a_type )

staticprotected

Get type as string.

Definition at line 310 of file class.ilAdvancedMDFieldDefinition.php.

                                                         : string
     {
         if (self::isValidType($a_type)) {
             $map = array(
                 self::TYPE_TEXT => "Text",
                 self::TYPE_SELECT => "Select",
                 self::TYPE_DATE => "Date",
                 self::TYPE_DATETIME => "DateTime",
                 self::TYPE_FLOAT => "Float",
                 self::TYPE_LOCATION => "Location",
                 self::TYPE_INTEGER => "Integer",
                 self::TYPE_SELECT_MULTI => "SelectMulti",
                 self::TYPE_EXTERNAL_LINK => 'ExternalLink',
                 self::TYPE_INTERNAL_LINK => 'InternalLink',
                 self::TYPE_ADDRESS => "Address"
             );
             return $map[$a_type];
         }
         return '';
     }

◆ getTypeTitle()

ilAdvancedMDFieldDefinition::getTypeTitle ( )

Todo:: check udf usage

Definition at line 346 of file class.ilAdvancedMDFieldDefinition.php.

References getType(), and initADTDefinition().

Referenced by ilAdvancedMDSettingsGUI\initFieldForm().

                                   : string
     {
         return "udf_type_" . strtolower(self::getTypeString($this->getType()));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidTypes()

static ilAdvancedMDFieldDefinition::getValidTypes ( )

static

Get all valid types.

Returns: int[]

Definition at line 280 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilAdvancedMDSettingsGUI\editFields().

                                           : array
     {
         return array(
             self::TYPE_TEXT,
             self::TYPE_DATE,
             self::TYPE_DATETIME,
             self::TYPE_SELECT,
             self::TYPE_INTEGER,
             self::TYPE_FLOAT,
             self::TYPE_LOCATION,
             self::TYPE_SELECT_MULTI,
             self::TYPE_EXTERNAL_LINK,
             self::TYPE_INTERNAL_LINK,
             self::TYPE_ADDRESS
         );
     }

Here is the caller graph for this function:

◆ getValueForXML()

ilAdvancedMDFieldDefinition::getValueForXML ( ilADT $element )

abstract

Parse ADT value for xml (export)

Referenced by importXMLProperty().

Here is the caller graph for this function:

◆ hasComplexOptions()

ilAdvancedMDFieldDefinition::hasComplexOptions ( )

Definition at line 1114 of file class.ilAdvancedMDFieldDefinition.php.

                                        : bool
     {
         return false;
     }

◆ import()

ilAdvancedMDFieldDefinition::import ( array $a_data )

protected

Import from DB.

Definition at line 785 of file class.ilAdvancedMDFieldDefinition.php.

References importFieldDefinition(), setDescription(), setFieldId(), setImportId(), setPosition(), setRecordId(), setRequired(), setSearchable(), and setTitle().

                                             : void
     {
         $this->setFieldId((int) $a_data["field_id"]);
         $this->setRecordId((int) $a_data["record_id"]);
         $this->setImportId((string) $a_data["import_id"]);
         $this->setTitle((string) $a_data["title"]);
         $this->setDescription((string) $a_data["description"]);
         $this->setPosition((int) $a_data["position"]);
         $this->setSearchable((bool) $a_data["searchable"]);
         $this->setRequired((bool) $a_data["required"]);
         if (isset($a_data['field_values'])) {
             $field_values = unserialize($a_data['field_values']);
             if (is_array($field_values)) {
                 $this->importFieldDefinition($field_values);
             }
         }
     }

Here is the call graph for this function:

◆ importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinition::importCustomDefinitionFormPostValues	(	ilPropertyFormGUI	$a_form,
		string	$language = `''`
	)

Import custom post values from definition form.

Definition at line 675 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by importDefinitionFormPostValues().

                                                                                                           : void
     {
         // type-specific
     }

Here is the caller graph for this function:

◆ importDefinitionFormPostValues()

ilAdvancedMDFieldDefinition::importDefinitionFormPostValues	(	ilPropertyFormGUI	$a_form,
		ilAdvancedMDPermissionHelper	$a_permissions,
		string	$active_language
	)

Import post values from definition form.

Definition at line 683 of file class.ilAdvancedMDFieldDefinition.php.

References ilAdvancedMDRecord\_getInstanceByRecordId(), ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ilAdvancedMDPermissionHelper\CONTEXT_FIELD, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilClaimingPermissionHelper\hasPermission(), importCustomDefinitionFormPostValues(), setDescription(), setSearchable(), setTitle(), and ilAdvancedMDPermissionHelper\SUBACTION_FIELD_PROPERTIES.

      : void {
         $record = ilAdvancedMDRecord::_getInstanceByRecordId($this->record_id);
         $is_translation = (($active_language !== '') && ($active_language != $record->getDefaultLanguage()));
         if (!$a_form->getItemByPostVar("title")->getDisabled() && !$is_translation) {
             $this->setTitle($a_form->getInput("title"));
         }
         if (!$a_form->getItemByPostVar("description")->getDisabled() && !$is_translation) {
             $this->setDescription($a_form->getInput("description"));
         }
         if (!$a_form->getItemByPostVar("searchable")->getDisabled()) {
             $this->setSearchable((bool) $a_form->getInput("searchable"));
         }
 
         if ($a_permissions->hasPermission(
             ilAdvancedMDPermissionHelper::CONTEXT_FIELD,
             (string) $this->getFieldId(),
             ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
             ilAdvancedMDPermissionHelper::SUBACTION_FIELD_PROPERTIES
         )) {
             $this->importCustomDefinitionFormPostValues($a_form, $active_language);
         }
     }

Here is the call graph for this function:

◆ importDefinitionFormPostValuesNeedsConfirmation()

ilAdvancedMDFieldDefinition::importDefinitionFormPostValuesNeedsConfirmation ( )

Definition at line 710 of file class.ilAdvancedMDFieldDefinition.php.

                                                                      : bool
     {
         return false;
     }

◆ importFieldDefinition()

ilAdvancedMDFieldDefinition::importFieldDefinition ( array $a_def )

protected

Import (type-specific) field definition from DB.

Definition at line 547 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import().

                                                           : void
     {
     }

Here is the caller graph for this function:

◆ importFromECS()

ilAdvancedMDFieldDefinition::importFromECS	(	string	$a_ecs_type,
			$a_value,
		string	$a_sub_id
	)

Import meta data from ECS.

Definition at line 954 of file class.ilAdvancedMDFieldDefinition.php.

                                                                                  : bool
     {
         return false;
     }

◆ importValueFromXML()

ilAdvancedMDFieldDefinition::importValueFromXML ( string $a_cdata )

abstract

Import value from xml.

Parameters

string $a_cdata

Referenced by importXMLProperty().

Here is the caller graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinition::importXMLProperty	(	string	$a_key,
		string	$a_value
	)

Import property from XML.

Definition at line 936 of file class.ilAdvancedMDFieldDefinition.php.

References getValueForXML(), and importValueFromXML().

                                                                      : void
     {
     }

Here is the call graph for this function:

◆ init()

ilAdvancedMDFieldDefinition::init ( )

protected

Definition at line 270 of file class.ilAdvancedMDFieldDefinition.php.

References setRequired(), and setSearchable().

Referenced by __construct().

                              : void
     {
         $this->setRequired(false);
         $this->setSearchable(false);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinition::initADTDefinition ( )

abstractprotected

Init adt instance.

Referenced by getADTDefinition(), and getTypeTitle().

Here is the caller graph for this function:

◆ isFilterSupported()

ilAdvancedMDFieldDefinition::isFilterSupported ( )

Is search by filter supported.

Definition at line 503 of file class.ilAdvancedMDFieldDefinition.php.

                                        : bool
     {
         return true;
     }

◆ isRequired()

ilAdvancedMDFieldDefinition::isRequired ( )

Is required field.

Definition at line 539 of file class.ilAdvancedMDFieldDefinition.php.

References $required.

Referenced by _clone(), and getDBProperties().

                                 : bool
     {
         return $this->required;
     }

Here is the caller graph for this function:

◆ isSearchable()

ilAdvancedMDFieldDefinition::isSearchable ( )

Is searchable.

Definition at line 523 of file class.ilAdvancedMDFieldDefinition.php.

References $searchable.

Referenced by _clone(), addToFieldDefinitionForm(), getDBProperties(), and toXML().

                                   : bool
     {
         return $this->searchable;
     }

Here is the caller graph for this function:

◆ isSearchSupported()

ilAdvancedMDFieldDefinition::isSearchSupported ( )

Is search supported at all.

Definition at line 495 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by addToFieldDefinitionForm(), and setSearchable().

                                        : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ isValidType()

static ilAdvancedMDFieldDefinition::isValidType ( int $a_type )

static

Definition at line 297 of file class.ilAdvancedMDFieldDefinition.php.

References getType(), and ILIAS\Repository\int().

Referenced by ilAdvancedMDClaimingPlugin\createDBField().

                                                    : bool
     {
         return in_array($a_type, self::getValidTypes());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseSearchObjects()

ilAdvancedMDFieldDefinition::parseSearchObjects	(	array	$a_records,
		array	$a_object_types
	)

protected

Add object-data needed for global search to AMD search results.

Definition at line 994 of file class.ilAdvancedMDFieldDefinition.php.

References $res.

Referenced by ilAdvancedMDFieldDefinitionInternalLink\searchObjects(), and searchObjects().

                                                                                   : array
     {
         $res = [];
         $obj_ids = [];
         foreach ($a_records as $record) {
             if ($record["sub_type"] == "-") {
                 $obj_ids[] = $record["obj_id"];
             }
         }
 
         $sql = "SELECT obj_id,type" .
             " FROM object_data" .
             " WHERE " . $this->db->in("obj_id", $obj_ids, false, "integer") .
             " AND " . $this->db->in("type", $a_object_types, false, "text");
         $set = $this->db->query($sql);
         while ($row = $this->db->fetchAssoc($set)) {
             $res[] = $row;
         }
         return $res;
     }

Here is the caller graph for this function:

◆ prepareCustomDefinitionFormConfirmation()

ilAdvancedMDFieldDefinition::prepareCustomDefinitionFormConfirmation ( ilPropertyFormGUI $a_form )

Definition at line 715 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by prepareDefinitionFormConfirmation().

                                                                                       : void
     {
     }

Here is the caller graph for this function:

◆ prepareDefinitionFormConfirmation()

ilAdvancedMDFieldDefinition::prepareDefinitionFormConfirmation ( ilPropertyFormGUI $a_form )

Definition at line 719 of file class.ilAdvancedMDFieldDefinition.php.

References ilPropertyFormGUI\addItem(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and prepareCustomDefinitionFormConfirmation().

                                                                                 : void
     {
         $a_form->getItemByPostVar("title")->setDisabled(true);
         $a_form->getItemByPostVar("description")->setDisabled(true);
         $a_form->getItemByPostVar("searchable")->setDisabled(true);
 
         // checkboxes have no hidden on disabled
         if ($a_form->getInput("searchable")) {
             $hidden = new ilHiddenInputGUI("searchable");
             $hidden->setValue("1");
             $a_form->addItem($hidden);
         }
 
         $this->prepareCustomDefinitionFormConfirmation($a_form);
     }

Here is the call graph for this function:

◆ prepareElementForEditor()

ilAdvancedMDFieldDefinition::prepareElementForEditor ( ilADTFormBridge $a_bridge )

Prepare editor form elements.

Definition at line 962 of file class.ilAdvancedMDFieldDefinition.php.

                                                                       : void
     {
         // type-specific
     }

◆ prepareElementForSearch()

ilAdvancedMDFieldDefinition::prepareElementForSearch ( ilADTSearchBridge $a_bridge )

Prepare search form elements.

Definition at line 1088 of file class.ilAdvancedMDFieldDefinition.php.

                                                                         : void
     {
     }

◆ read()

ilAdvancedMDFieldDefinition::read ( ?int $a_field_id )

protected

Read field definition.

Definition at line 806 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by __construct().

                                              : void
     {
         if (!(int) $a_field_id) {
             return;
         }
 
         $sql = "SELECT * FROM adv_mdf_definition" .
             " WHERE field_id = " . $this->db->quote($a_field_id, "integer");
         $set = $this->db->query($sql);
         if ($this->db->numRows($set)) {
             $row = $this->db->fetchAssoc($set);
             $this->import($row);
         }
     }

Here is the caller graph for this function:

◆ save()

ilAdvancedMDFieldDefinition::save ( bool $a_keep_pos = false )

Create new field entry.

Definition at line 824 of file class.ilAdvancedMDFieldDefinition.php.

References generateImportId(), getDBProperties(), getFieldId(), getImportId(), getLastPosition(), setFieldId(), setImportId(), setPosition(), and update().

Referenced by update().

                                                   : void
     {
         if ($this->getFieldId()) {
             $this->update();
             return;
         }
 
         $next_id = $this->db->nextId("adv_mdf_definition");
 
         // append
         if (!$a_keep_pos) {
             $this->setPosition($this->getLastPosition() + 1);
         }
 
         // needs unique import id
         if (!$this->getImportId()) {
             $this->setImportId($this->generateImportId($next_id));
         }
 
         $fields = $this->getDBProperties();
         $fields["field_id"] = array("integer", $next_id);
 
         $this->db->insert("adv_mdf_definition", $fields);
 
         $this->setFieldId($next_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ searchObjects()

ilAdvancedMDFieldDefinition::searchObjects	(	ilADTSearchBridge	$a_adt_search,
		ilQueryParser	$a_parser,
		array	$a_object_types,
		string	$a_locate,
		string	$a_search_type
	)

Search objects.

Definition at line 1050 of file class.ilAdvancedMDFieldDefinition.php.

References ilADTActiveRecordByType\find(), getADT(), getFieldId(), ilADTSearchBridge\getSQLCondition(), getType(), parseSearchObjects(), and ilADTActiveRecordByType\SINGLE_COLUMN_NAME.

      : array {
         // search type only supported/needed for text
         $condition = $a_adt_search->getSQLCondition(ilADTActiveRecordByType::SINGLE_COLUMN_NAME);
         if ($condition) {
             $objects = ilADTActiveRecordByType::find(
                 "adv_md_values",
                 $this->getADT()->getType(),
                 $this->getFieldId(),
                 $condition,
                 $a_locate
             );
             if (sizeof($objects)) {
                 return $this->parseSearchObjects($objects, $a_object_types);
             }
         }
         return [];
     }

Here is the call graph for this function:

◆ searchSubObjects()

ilAdvancedMDFieldDefinition::searchSubObjects	(	ilADTSearchBridge	$a_adt_search,
		int	$a_obj_id,
		string	$sub_obj_type
	)

Definition at line 1015 of file class.ilAdvancedMDFieldDefinition.php.

References $res, ilADTActiveRecordByType\find(), getADT(), getFieldId(), ilADTSearchBridge\getSQLCondition(), getType(), and ilADTActiveRecordByType\SINGLE_COLUMN_NAME.

                                                                                                           : array
     {
         $element_id = ilADTActiveRecordByType::SINGLE_COLUMN_NAME;
 
         // :TODO:
         if ($a_adt_search instanceof ilADTLocationSearchBridgeSingle) {
             $element_id = "loc";
         }
 
         $condition = $a_adt_search->getSQLCondition($element_id);
         if ($condition) {
             $objects = ilADTActiveRecordByType::find(
                 "adv_md_values",
                 $this->getADT()->getType(),
                 $this->getFieldId(),
                 $condition
             );
             if (sizeof($objects)) {
                 $res = array();
                 foreach ($objects as $item) {
                     if ($item["obj_id"] == $a_obj_id &&
                         $item["sub_type"] == $sub_obj_type) {
                         $res[] = $item["sub_id"];
                     }
                 }
                 return $res;
             }
         }
 
         return array();
     }

Here is the call graph for this function:

◆ setADT()

ilAdvancedMDFieldDefinition::setADT ( ilADT $a_adt )

protected

Set ADT instance.

See also: self::getADTGroupForDefinitions()

Definition at line 380 of file class.ilAdvancedMDFieldDefinition.php.

                                            : void
     {
         if (!$this->adt instanceof ilADT) {
             $this->adt = $a_adt;
         }
     }

◆ setDescription()

ilAdvancedMDFieldDefinition::setDescription ( string $a_desc )

Set description.

Definition at line 476 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and importDefinitionFormPostValues().

                                                   : void
     {
         if ($a_desc !== null) {
             $a_desc = trim($a_desc);
         }
         $this->description = $a_desc;
     }

Here is the caller graph for this function:

◆ setFieldId()

ilAdvancedMDFieldDefinition::setFieldId ( int $a_id )

protected

Set field_id.

Definition at line 390 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and save().

                                             : void
     {
         $this->field_id = $a_id;
     }

Here is the caller graph for this function:

◆ setImportId()

ilAdvancedMDFieldDefinition::setImportId ( string $a_id_string )

Set import id.

Definition at line 422 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and save().

                                                     : void
     {
         if ($a_id_string !== null) {
             $a_id_string = trim($a_id_string);
         }
         $this->import_id = $a_id_string;
     }

Here is the caller graph for this function:

◆ setPosition()

ilAdvancedMDFieldDefinition::setPosition ( int $a_pos )

Set position.

Definition at line 441 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and save().

                                            : void
     {
         $this->position = $a_pos;
     }

Here is the caller graph for this function:

◆ setRecordId()

ilAdvancedMDFieldDefinition::setRecordId ( int $a_id )

Set record id.

Definition at line 406 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import().

                                           : void
     {
         $this->record_id = $a_id;
     }

Here is the caller graph for this function:

◆ setRequired()

ilAdvancedMDFieldDefinition::setRequired ( bool $a_status )

Toggle required.

Definition at line 531 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and init().

                                                : void
     {
         $this->required = $a_status;
     }

Here is the caller graph for this function:

◆ setSearchable()

ilAdvancedMDFieldDefinition::setSearchable ( bool $a_status )

Toggle searchable.

Definition at line 511 of file class.ilAdvancedMDFieldDefinition.php.

References isSearchSupported().

Referenced by import(), importDefinitionFormPostValues(), and init().

                                                  : void
     {
         // see above
         if (!$this->isSearchSupported()) {
             $a_status = false;
         }
         $this->searchable = (bool) $a_status;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSearchValueSerialized()

ilAdvancedMDFieldDefinition::setSearchValueSerialized	(	ilADTSearchBridge	$a_adt_search,
			$a_value
	)

Set value from search persistence.

Definition at line 986 of file class.ilAdvancedMDFieldDefinition.php.

References ilADTSearchBridge\setSerializedValue().

                                                                                        : void
     {
         $a_adt_search->setSerializedValue($a_value);
     }

Here is the call graph for this function:

◆ setTitle()

ilAdvancedMDFieldDefinition::setTitle ( string $a_title )

Get title.

Definition at line 457 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and importDefinitionFormPostValues().

                                              : void
     {
         if ($a_title !== null) {
             $a_title = trim($a_title);
         }
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ toXML()

ilAdvancedMDFieldDefinition::toXML ( ilXmlWriter $a_writer )

To Xml.

This method writes only the subset Field Use class.ilAdvancedMDRecordXMLWriter to generate a complete xml presentation.

Definition at line 890 of file class.ilAdvancedMDFieldDefinition.php.

References addPropertiesToXML(), generateImportId(), getDescription(), getFieldId(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), getPosition(), getRecordId(), getTitle(), getType(), isSearchable(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                                 : void
     {
         $a_writer->xmlStartTag('Field', array(
             'id' => $this->generateImportId($this->getFieldId()),
             'searchable' => ($this->isSearchable() ? 'Yes' : 'No'),
             'fieldType' => self::getTypeString($this->getType())
         ));
 
         $a_writer->xmlElement('FieldTitle', null, $this->getTitle());
         $a_writer->xmlElement('FieldDescription', null, $this->getDescription());
 
         $translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($this->getRecordId());
         $a_writer->xmlStartTag('FieldTranslations');
         foreach ($translations->getTranslations($this->getFieldId()) as $translation) {
             $a_writer->xmlStartTag('FieldTranslation', ['language' => $translation->getLangKey()]);
             $a_writer->xmlElement(
                 'FieldTranslationTitle',
                 [],
                 $translation->getTitle()
             );
             $a_writer->xmlElement(
                 'FieldTranslationDescription',
                 [],
                 $translation->getDescription()
             );
             $a_writer->xmlEndTag('FieldTranslation');
         }
         $a_writer->xmlEndTag('FieldTranslations');
         $a_writer->xmlElement('FieldPosition', null, $this->getPosition());
 
         $this->addPropertiesToXML($a_writer);
 
         $a_writer->xmlEndTag('Field');
     }

Here is the call graph for this function:

◆ update()

ilAdvancedMDFieldDefinition::update ( )

Update field entry.

Definition at line 854 of file class.ilAdvancedMDFieldDefinition.php.

References getDBProperties(), getFieldId(), and save().

Referenced by save().

                             : void
     {
         if (!$this->getFieldId()) {
             $this->save();
             return;
         }
 
         $this->db->update(
             "adv_mdf_definition",
             $this->getDBProperties(),
             array("field_id" => array("integer", $this->getFieldId()))
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ useDefaultLanguageMode()

ilAdvancedMDFieldDefinition::useDefaultLanguageMode ( string $language )

Check if default language mode has to be used: no language given or language equals default language.

Definition at line 334 of file class.ilAdvancedMDFieldDefinition.php.

References $language, and ilAdvancedMDRecord\_getInstanceByRecordId().

Referenced by ilAdvancedMDFieldDefinitionSelect\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionInteger\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionInteger\getFieldDefinitionForTableGUI(), ilAdvancedMDFieldDefinitionInteger\importCustomDefinitionFormPostValues(), and ilAdvancedMDFieldDefinitionSelect\importNewSelectOptions().

                                                             : bool
     {
         if (!strlen($language)) {
             return true;
         }
         $record = ilAdvancedMDRecord::_getInstanceByRecordId($this->record_id);
         return strcmp($record->getDefaultLanguage(), $language) === 0;
     }