ilAdvancedMDFieldDefinition Class Reference

AMD field abstract base class. More...

Inheritance diagram for ilAdvancedMDFieldDefinition:

Collaboration diagram for ilAdvancedMDFieldDefinition:

Public Member Functions
	__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)

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

Static Protected Member Functions
static	getInstanceWithData (GenericData $generic_data, string $language='')
static	getTypeString (int $a_type)
	Get type as string. More...

Protected Attributes
GenericData	$generic_data
ilADTDefinition	$adt_def = null
ilADT	$adt = null
string	$language = ''
ilDBInterface	$db
ilLanguage	$lng
ilLogger	$logger
GlobalHttpState	$http
RefineryFactory	$refinery

Private Attributes
DBGateway	$db_gateway

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

Constructor & Destructor Documentation

__construct()

ilAdvancedMDFieldDefinition::__construct	(	GenericData	$generic_data,
		string	$language = ''
	)

PhpUndefinedMethodInspection

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

References $DIC, $generic_data, $language, ILIAS\MetaData\Elements\Data\Data\FieldDefinition\GenericData\GenericData\getFieldValues(), ILIAS\FileDelivery\http(), importFieldDefinition(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), 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->db_gateway = new DatabaseGatewayImplementation($this->db);

        $this->generic_data = $generic_data;
        if (!empty($generic_data->getFieldValues())) {
            $this->importFieldDefinition($generic_data->getFieldValues());
        }
    }

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

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

Referenced by ilAdvancedMDFieldDefinitionSelect\readOptions().

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

Referenced by addToFieldDefinitionForm().

     : void {
    }

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 835 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 566 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 780 of file class.ilAdvancedMDFieldDefinition.php.

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

                            : void
    {
        if (!$this->getFieldId()) {
            return;
        }

        // delete all values
        ilAdvancedMDValues::_deleteByFieldId($this->getFieldId(), $this->getADT());

        $this->db_gateway->delete($this->getFieldId());
    }

Here is the call graph for this function:

exists()

static ilAdvancedMDFieldDefinition::exists ( int  $a_field_id )

static

Definition at line 146 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 724 of file class.ilAdvancedMDFieldDefinition.php.

References IL_INST_ID.

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

getADT()

ilAdvancedMDFieldDefinition::getADT

(

)

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

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

Referenced by delete(), ilAdvancedMDFieldDefinitionDate\importFromECS(), ilAdvancedMDFieldDefinitionDateTime\importFromECS(), ilAdvancedMDFieldDefinitionText\importFromECS(), ilAdvancedMDFieldDefinitionExternalLink\importValueFromXML(), ilAdvancedMDFieldDefinitionInternalLink\importValueFromXML(), ilAdvancedMDFieldDefinitionLocation\importValueFromXML(), ilAdvancedMDFieldDefinitionDate\importValueFromXML(), ilAdvancedMDFieldDefinitionDateTime\importValueFromXML(), ilAdvancedMDFieldDefinitionSelectMulti\importValueFromXML(), ilAdvancedMDFieldDefinitionGroupBased\importValueFromXML(), ilAdvancedMDFieldDefinitionInteger\importValueFromXML(), ilAdvancedMDFieldDefinitionText\importValueFromXML(), ilAdvancedMDFieldDefinitionSelect\importValueFromXML(), ILIAS\Cache\Services\SubObjectModes\Filter\Supplier\initFilterInput(), ilAdvancedMDFieldDefinitionInternalLink\searchObjects(), ilAdvancedMDFieldDefinitionText\searchObjects(), searchObjects(), and searchSubObjects().

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

References $adt_def, and initADTDefinition().

Referenced by getADT(), ilAdvancedMDFieldDefinitionText\getADTGroup(), ilAdvancedMDFieldDefinitionSelect\importNewSelectOptions(), ILIAS\Cache\Services\SubObjectModes\DataTable\Supplier\initColumn(), ILIAS\Cache\Services\SubObjectModes\Filter\Supplier\initFilterInput(), 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 286 of file class.ilAdvancedMDFieldDefinition.php.

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

References null.

                                                                                       : ?string
    {
        return null;
    }

getDescription()

ilAdvancedMDFieldDefinition::getDescription

(

)

Get description.

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

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

                                    : string
    {
        return $this->generic_data->getDescription();
    }

Here is the caller graph for this function:

getFieldDefinition()

ilAdvancedMDFieldDefinition::getFieldDefinition ( )

protected

Get (type-specific) field definition.

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

Referenced by _clone(), save(), and update().

                                           : array
    {
        return [];
    }

Here is the caller graph for this function:

getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinition::getFieldDefinitionForTableGUI

(

string

$content_language

)

Parse properties for table gui.

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

                                                                           : array
    {
        return [];
    }

getFieldId()

ilAdvancedMDFieldDefinition::getFieldId

(

)

Get field_id.

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

Referenced by addToFieldDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\buildConfirmedObjects(), delete(), ilAdvancedMDFieldDefinitionSelect\deleteOptions(), ilAdvancedMDFieldDefinitionSelect\findBySingleValue(), ILIAS\Cache\Services\SubObjectModes\DataTable\Supplier\initColumn(), ilAdvancedMDSettingsGUI\initFieldForm(), ILIAS\Cache\Services\SubObjectModes\Filter\Supplier\initFilterInput(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), ilAdvancedMDFieldDefinitionSelect\readOptions(), save(), ilAdvancedMDFieldDefinitionSelect\saveOptions(), ilAdvancedMDFieldDefinitionInternalLink\searchObjects(), ilAdvancedMDFieldDefinitionText\searchObjects(), searchObjects(), searchSubObjects(), ilAdvancedMDFieldDefinitionSelect\update(), update(), and ilAdvancedMDFieldDefinitionSelect\updateOptions().

                                : ?int
    {
        return $this->generic_data->id();
    }

Here is the caller graph for this function:

getImportId()

ilAdvancedMDFieldDefinition::getImportId

(

)

Get import id.

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

Referenced by toXML().

                                 : string
    {
        return $this->generic_data->getImportID();
    }

Here is the caller graph for this function:

getInstance()

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

static

TODO: In the future, this should probably be supplied by the repo.

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

References $DIC, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by ILIAS\UI\Component\Legacy\Content\Filter\FilterManager\apply(), ilAdvancedMDSettingsGUI\confirmDeleteFields(), ilAdvancedMDSettingsGUI\createField(), ilAdvancedMDSettingsGUI\deleteFields(), ilAdvancedMDSettingsGUI\editComplexOption(), ilAdvancedMDSettingsGUI\editField(), ilAdvancedMDSettingsGUI\editFields(), ilPresentationTableGUI\getADTSearchBridges(), ilContainerFilterAdvMDAdapter\getAdvType(), ilContainerFilterUtil\getContainerFieldTitle(), ilLuceneAdvancedSearchFields\getFormElement(), ilContainerFilterAdvMDAdapter\getOptions(), ilContainerFilterAdvMDAdapter\getTitle(), ilLuceneAdvancedSearchFields\parseFieldQuery(), ilLuceneAdvancedSearchFields\readSections(), ilAdvancedMDSettingsGUI\saveField(), ilAdvancedSearchGUI\searchAdvancedMD(), ilAdvancedMDSettingsGUI\updateComplexOption(), and ilAdvancedMDSettingsGUI\updateField().

     : ilAdvancedMDFieldDefinition {
        global $DIC;

        $db_gateway = new DatabaseGatewayImplementation($DIC->database());

        if (self::isValidType((int) $a_type)) {
            $generic_data = new GenericDataImplementation(
                Type::from($a_type),
                0,
                '',
                '',
                '',
                0,
                false,
                false,
                []
            );
        }

        if ($a_field_id) {
            $generic_data = $db_gateway->readByID($a_field_id);
        }

        if (isset($generic_data)) {
            return self::getInstanceWithData($generic_data);
        }
        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 245 of file class.ilAdvancedMDFieldDefinition.php.

References $data, $DIC, and null.

Referenced by ilAdvancedMDParser\initValue().

                                                                     : ?ilAdvancedMDFieldDefinition
    {
        global $DIC;

        $db_gateway = new DatabaseGatewayImplementation($DIC->database());

        if (is_null($data = $db_gateway->readByImportID($a_import_id))) {
            return null;
        }
        return self::getInstanceWithData($data);
    }

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

References null.

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

References $data, $DIC, $ilDB, $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->database();
        $db_gateway = new DatabaseGatewayImplementation($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);
        $ids = [];
        while ($row = $ilDB->fetchAssoc($res)) {
            $ids[] = (int) $row["field_id"];
        }
        $data = $db_gateway->readByIDs(...$ids);

        $defs = [];
        foreach ($data as $datum) {
            $defs[$datum->id()] = self::getInstanceWithData($datum);
        }

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

References $data, and $DIC.

Referenced by ilAdvancedMDRecord\_clone(), ilGlossaryTerm\_copyTerm(), ilAdvancedMDRecord\_delete(), ilAdvancedMDSettingsGUI\editFields(), ilAdvancedMDRecordTableGUI\fillRow(), ilObjBookingPool\getAdvancedMDFields(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilContainerFilterAdvMDAdapter\getAvailableRecordSets(), ILIAS\Cache\Services\SubObjectModes\DataTable\Supplier\getData(), ilAdvancedMDValues\getDefinitions(), ilLuceneAdvancedSearchFields\getFields(), ilPCAMDPageList\handleCopiedContent(), ILIAS\Cache\Services\SubObjectModes\DataTable\Supplier\initColumns(), ILIAS\Cache\Services\SubObjectModes\Filter\Supplier\initFilterInputs(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDRecordGUI\parseTableCells(), ilAdvancedMDRecordGUI\parseTableHead(), ilAdvancedMDValues\queryForRecords(), ilAdvancedMDFieldTranslations\read(), ilAdvancedMDRecord\toXML(), and ilAdvancedMDSettingsGUI\updateFields().

     : array {
        global $DIC;

        $db_gateway = new DatabaseGatewayImplementation($DIC->database());

        $defs = [];
        foreach ($db_gateway->readByRecords($a_only_searchable, $a_record_id) as $data) {
            $defs[$data->id()] = self::getInstanceWithData($data);
        }
        return $defs;
    }

Here is the caller graph for this function:

getInstanceWithData()

static ilAdvancedMDFieldDefinition::getInstanceWithData ( GenericData  $generic_data, string  $language = ''  )

staticprotected

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

References ILIAS\MetaData\Elements\Data\Data\FieldDefinition\GenericData\GenericData\type().

     : ilAdvancedMDFieldDefinition {
        $class = "ilAdvancedMDFieldDefinition" . $generic_data->type()->stringValue();
        return new $class($generic_data, $language);
    }

Here is the call 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 987 of file class.ilAdvancedMDFieldDefinition.php.

    {
        return $a_value;
    }

getPosition()

ilAdvancedMDFieldDefinition::getPosition

(

)

Get position.

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

Referenced by _clone(), and toXML().

                                 : int
    {
        return $this->generic_data->getPosition();
    }

Here is the caller graph for this function:

getRecordId()

ilAdvancedMDFieldDefinition::getRecordId

(

)

Get record id.

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

Referenced by ilAdvancedMDFieldDefinitionInteger\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionText\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\addCustomFieldToDefinitionFormInTranslationMode(), addToFieldDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\importXMLProperty(), ilAdvancedMDFieldDefinitionText\initADTDefinition(), ilAdvancedMDFieldDefinitionSelect\readOptions(), toXML(), and ilAdvancedMDFieldDefinitionSelect\translateLegacyImportValueFromXML().

                                 : int
    {
        return $this->generic_data->getRecordID();
    }

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

References $DIC, $ilDB, 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 880 of file class.ilAdvancedMDFieldDefinition.php.

                                                                              : string
    {
        return '';
    }

getSearchValueSerialized()

ilAdvancedMDFieldDefinition::getSearchValueSerialized

(

ilADTSearchBridge

$a_adt_search

)

Definition at line 885 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 457 of file class.ilAdvancedMDFieldDefinition.php.

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

                              : string
    {
        return $this->generic_data->getTitle();
    }

Here is the caller graph for this function:

getType()

ilAdvancedMDFieldDefinition::getType ( )

abstract

Get type.

Referenced by getTypeTitle(), ILIAS\Cache\Services\SubObjectModes\DataTable\Supplier\initColumn(), ILIAS\Cache\Services\SubObjectModes\DataTable\Supplier\initData(), ILIAS\Cache\Services\SubObjectModes\Filter\Supplier\initFilterInput(), 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 329 of file class.ilAdvancedMDFieldDefinition.php.

                                                        : string
    {
        return (string) (Type::tryFrom($a_type)?->stringValue());
    }

getTypeTitle()

ilAdvancedMDFieldDefinition::getTypeTitle

(

)

Todo:

check udf usage

Definition at line 349 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 306 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilAdvancedMDSettingsGUI\editFields().

                                          : array
    {
        $types = Type::cases();
        $values = [];
        foreach ($types as $type) {
            $values[] = $type->value;
        }
        return $values;
    }

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

                                       : bool
    {
        return false;
    }

importCustomDefinitionFormPostValues()

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

Import custom post values from definition form.

Definition at line 661 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 669 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->getRecordID());
        $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 696 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 533 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by __construct().

                                                          : 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 861 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 843 of file class.ilAdvancedMDFieldDefinition.php.

References getValueForXML(), and importValueFromXML().

                                                                     : void
    {
    }

Here is the call 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 489 of file class.ilAdvancedMDFieldDefinition.php.

                                       : bool
    {
        return true;
    }

isRequired()

ilAdvancedMDFieldDefinition::isRequired

(

)

Is required field.

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

Referenced by _clone().

                                : bool
    {
        return $this->generic_data->isRequired();
    }

Here is the caller graph for this function:

isSearchable()

ilAdvancedMDFieldDefinition::isSearchable

(

)

Is searchable.

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

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

                                  : bool
    {
        return $this->generic_data->isSearchable();
    }

Here is the caller graph for this function:

isSearchSupported()

ilAdvancedMDFieldDefinition::isSearchSupported

(

)

Is search supported at all.

Definition at line 481 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 316 of file class.ilAdvancedMDFieldDefinition.php.

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

Referenced by ilAdvancedMDClaimingPlugin\createDBField().

                                                   : bool
    {
        return !is_null(Type::tryFrom($a_type));
    }

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 901 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 701 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 705 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 869 of file class.ilAdvancedMDFieldDefinition.php.

                                                                      : void
    {
        // type-specific
    }

prepareElementForSearch()

ilAdvancedMDFieldDefinition::prepareElementForSearch

(

ilADTSearchBridge

$a_bridge

)

Prepare search form elements.

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

                                                                        : void
    {
    }

save()

ilAdvancedMDFieldDefinition::save	(	bool	$keep_pos_and_import_id = false,
		bool	$keep_import_id = false
	)

Create new field entry.

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

References getFieldDefinition(), getFieldId(), and update().

Referenced by update().

                                                                                            : void
    {
        if ($this->getFieldId()) {
            $this->update();
            return;
        }

        /*
         * This has to be set before update and creation here, the alternative
         * would be to set this in all children of this class, everywhere
         * where type-specific settings are set.
         */
        $this->generic_data->setFieldValues($this->getFieldDefinition());

        if ($keep_pos_and_import_id) {
            $field_id = $this->db_gateway->create($this->generic_data);
        } elseif ($keep_import_id) {
            $field_id = $this->db_gateway->createWithNewPosition($this->generic_data);
        } else {
            $field_id = $this->db_gateway->createFromScratch($this->generic_data);
        }

        $this->generic_data = $this->db_gateway->readByID($field_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 957 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 922 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 383 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 465 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by importDefinitionFormPostValues().

                                                  : void
    {
        $this->generic_data->setDescription(trim($a_desc));
    }

Here is the caller graph for this function:

setImportId()

ilAdvancedMDFieldDefinition::setImportId

(

string

$a_id_string

)

Set import id.

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

                                                    : void
    {
        $this->generic_data->setImportID(trim($a_id_string));
    }

setPosition()

ilAdvancedMDFieldDefinition::setPosition

(

int

$a_pos

)

Set position.

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

                                           : void
    {
        $this->generic_data->setPosition($a_pos);
    }

setRecordId()

ilAdvancedMDFieldDefinition::setRecordId

(

int

$a_id

)

Set record id.

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

                                          : void
    {
        $this->generic_data->setRecordID($a_id);
    }

setRequired()

ilAdvancedMDFieldDefinition::setRequired

(

bool

$a_status

)

Toggle required.

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

                                               : void
    {
        $this->generic_data->setRequired($a_status);
    }

setSearchable()

ilAdvancedMDFieldDefinition::setSearchable

(

bool

$a_status

)

Toggle searchable.

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

References isSearchSupported().

Referenced by importDefinitionFormPostValues().

                                                 : void
    {
        // see above
        if (!$this->isSearchSupported()) {
            $a_status = false;
        }
        $this->generic_data->setSearchable($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 893 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 449 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by importDefinitionFormPostValues().

                                             : void
    {
        $this->generic_data->setTitle(trim($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 797 of file class.ilAdvancedMDFieldDefinition.php.

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

                                                : void
    {
        $a_writer->xmlStartTag('Field', array(
            'id' => $this->getImportId(),
            '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 760 of file class.ilAdvancedMDFieldDefinition.php.

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

Referenced by save().

                            : void
    {
        if (!$this->getFieldId()) {
            $this->save();
            return;
        }

        /*
         * This has to be set before update and creation here, the alternative
         * would be to set this in all children of this class, everywhere
         * where type-specific settings are set.
         */
        $this->generic_data->setFieldValues($this->getFieldDefinition());

        $this->db_gateway->update($this->generic_data);
    }

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 337 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->getRecordID());
        return strcmp($record->getDefaultLanguage(), $language) === 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$adt

ilADT ilAdvancedMDFieldDefinition::$adt = null

protected

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

Referenced by ilAdvancedMDFieldDefinitionGroupBased\exportOptionToTableGUI(), getADT(), ilAdvancedMDFieldDefinitionGroupBased\getADTForOption(), ilAdvancedMDFieldDefinitionExternalLink\importValueFromXML(), ilAdvancedMDFieldDefinitionLocation\importValueFromXML(), ilAdvancedMDFieldDefinitionGroupBased\initOptionForm(), and ilAdvancedMDFieldDefinitionGroupBased\updateComplexOption().

$adt_def

ilADTDefinition ilAdvancedMDFieldDefinition::$adt_def = null

protected

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

Referenced by getADTDefinition().

$db

ilDBInterface ilAdvancedMDFieldDefinition::$db

protected

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

$db_gateway

DBGateway ilAdvancedMDFieldDefinition::$db_gateway

private

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

$generic_data

GenericData ilAdvancedMDFieldDefinition::$generic_data

protected

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

Referenced by __construct().

$http

GlobalHttpState ilAdvancedMDFieldDefinition::$http

protected

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

$language

string ilAdvancedMDFieldDefinition::$language = ''

protected

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

Referenced by ilAdvancedMDFieldDefinitionFloat\__construct(), ilAdvancedMDFieldDefinitionSelect\__construct(), __construct(), ilAdvancedMDFieldDefinitionFloat\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionInteger\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\addCustomFieldToDefinitionFormInTranslationMode(), ilAdvancedMDFieldDefinitionSelectMulti\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionFloat\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionInteger\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionSelect\importCustomDefinitionFormPostValues(), ilAdvancedMDFieldDefinitionSelect\importNewSelectOptions(), ilAdvancedMDFieldDefinitionSelect\importXMLProperty(), ilAdvancedMDFieldDefinitionInteger\setSuffixTranslation(), and useDefaultLanguageMode().

$lng

ilLanguage ilAdvancedMDFieldDefinition::$lng

protected

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

Referenced by ilAdvancedMDFieldDefinitionGroupBased\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionFloat\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionText\addCustomFieldToDefinitionForm(), ilAdvancedMDFieldDefinitionGroupBased\getFieldDefinitionForTableGUI(), ilAdvancedMDFieldDefinitionFloat\getFieldDefinitionForTableGUI(), ilAdvancedMDFieldDefinitionText\getFieldDefinitionForTableGUI(), ilAdvancedMDFieldDefinitionAddress\getTitles(), ilAdvancedMDFieldDefinitionGroupBased\initOptionForm(), and ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation().

$logger

ilLogger ilAdvancedMDFieldDefinition::$logger

protected

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

$refinery

RefineryFactory ilAdvancedMDFieldDefinition::$refinery

protected

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

TYPE_ADDRESS

const ilAdvancedMDFieldDefinition::TYPE_ADDRESS = 99

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

TYPE_DATE

const ilAdvancedMDFieldDefinition::TYPE_DATE = 3

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

Referenced by ilBookingObjectsTableGUI\numericOrdering().

TYPE_DATETIME

const ilAdvancedMDFieldDefinition::TYPE_DATETIME = 4

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

TYPE_EXTERNAL_LINK

const ilAdvancedMDFieldDefinition::TYPE_EXTERNAL_LINK = 9

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

TYPE_FLOAT

const ilAdvancedMDFieldDefinition::TYPE_FLOAT = 6

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

TYPE_INTEGER

const ilAdvancedMDFieldDefinition::TYPE_INTEGER = 5

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

Referenced by ilContainerFilterUtil\getContainerRecordTitle().

TYPE_INTERNAL_LINK

const ilAdvancedMDFieldDefinition::TYPE_INTERNAL_LINK = 10

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

TYPE_LOCATION

const ilAdvancedMDFieldDefinition::TYPE_LOCATION = 7

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

TYPE_SELECT

const ilAdvancedMDFieldDefinition::TYPE_SELECT = 1

TODO: put this in when minimum php version is set to 8.2.

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

Referenced by ilAdvancedMDClaimingPlugin\createDBField(), and ilContainerFilterUtil\getContainerRecordTitle().

TYPE_SELECT_MULTI

const ilAdvancedMDFieldDefinition::TYPE_SELECT_MULTI = 8

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

Referenced by ilAdvancedMDClaimingPlugin\createDBField(), and ilContainerFilterUtil\getContainerRecordTitle().

TYPE_TEXT

const ilAdvancedMDFieldDefinition::TYPE_TEXT = 2

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

Referenced by ilContainerFilterUtil\getContainerRecordTitle().

---

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

• components/ILIAS/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php