AMD field type float (based on integer) More...

Inheritance diagram for ilAdvancedMDFieldDefinitionFloat:

Collaboration diagram for ilAdvancedMDFieldDefinitionFloat:

Public Member Functions
	__construct (GenericData $generic_data, string $language='')

	getType ()
	Get type. More...

	isFilterSupported ()
	Is search by filter supported. More...

	setDecimals ($a_value)
	Set decimals. More...

	getDecimals ()
	Get decimals. More...

	getFieldDefinitionForTableGUI (string $content_language)
	Parse properties for table gui. More...

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
	Import custom post values from definition form. More...

	importXMLProperty (string $a_key, string $a_value)
	Import property from XML. More...

Public Member Functions inherited from ilAdvancedMDFieldDefinitionInteger
	getType ()
	Get type. More...

	isFilterSupported ()
	Is search by filter supported. More...

	getSuffixTranslations ()

	setSuffixTranslation (string $language, string $suffix)

	setSuffixTranslations (array $suffix_translations)

	setMin (?int $a_value)

	getMin ()

	setMax (?int $a_value)

	getMax ()

	setSuffix (?string $a_value)

	getSuffix ()

	getFieldDefinitionForTableGUI (string $content_language)
	Parse properties for table gui. More...

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
	Import custom post values from definition form. More...

	importXMLProperty (string $a_key, string $a_value)
	Import property from XML. More...

	getValueForXML (ilADT $element)
	Parse ADT value for xml (export) More...

	importValueFromXML (string $a_cdata)
	Import value from xml. More...

Public Member Functions inherited from ilAdvancedMDFieldDefinition
	__construct (GenericData $generic_data, string $language='')

	getType ()
	Get type. More...

	useDefaultLanguageMode (string $language)
	Check if default language mode has to be used: no language given or language equals default language. More...

	getTypeTitle ()

	getADTDefinition ()
	Get ADT definition instance. More...

	getADT ()

	getFieldId ()
	Get field_id. More...

	setRecordId (int $a_id)
	Set record id. More...

	getRecordId ()
	Get record id. More...

	setImportId (string $a_id_string)
	Set import id. More...

	getImportId ()
	Get import id. More...

	setPosition (int $a_pos)
	Set position. More...

	getPosition ()
	Get position. More...

	setTitle (string $a_title)
	Get title. More...

	getTitle ()
	Get title. More...

	setDescription (string $a_desc)
	Set description. More...

	getDescription ()
	Get description. More...

	isSearchSupported ()
	Is search supported at all. More...

	isFilterSupported ()
	Is search by filter supported. More...

	setSearchable (bool $a_status)
	Toggle searchable. More...

	isSearchable ()
	Is searchable. More...

	setRequired (bool $a_status)
	Toggle required. More...

	isRequired ()
	Is required field. More...

	getFieldDefinitionForTableGUI (string $content_language)
	Parse properties for table gui. More...

	addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $language='')
	Add input elements to definition form. More...

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
	Import custom post values from definition form. More...

	importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $active_language)
	Import post values from definition form. More...

	importDefinitionFormPostValuesNeedsConfirmation ()

	prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

	prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

	generateImportId (int $a_field_id)
	Generate unique record id. More...

	save (bool $keep_pos_and_import_id=false, bool $keep_import_id=false)
	Create new field entry. More...

	update ()
	Update field entry. More...

	delete ()
	Delete field entry. More...

	toXML (ilXmlWriter $a_writer)
	To Xml. More...

	importXMLProperty (string $a_key, string $a_value)
	Import property from XML. More...

	getValueForXML (ilADT $element)
	Parse ADT value for xml (export) More...

	importValueFromXML (string $a_cdata)
	Import value from xml. More...

	importFromECS (string $a_ecs_type, $a_value, string $a_sub_id)
	Import meta data from ECS. More...

	prepareElementForEditor (ilADTFormBridge $a_bridge)
	Prepare editor form elements. More...

	getSearchQueryParserValue (ilADTSearchBridge $a_adt_search)
	Get value for search query parser. More...

	getSearchValueSerialized (ilADTSearchBridge $a_adt_search)

	setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)
	Set value from search persistence. More...

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

	searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, string $a_locate, string $a_search_type)
	Search objects. More...

	getLuceneSearchString ($a_value)
	Get search string in lucene syntax. More...

	prepareElementForSearch (ilADTSearchBridge $a_bridge)
	Prepare search form elements. More...

	_clone (int $a_new_record_id)
	Clone field definition. More...

	hasComplexOptions ()

	getComplexOptionsOverview (object $a_parent_gui, string $parent_cmd)

Protected Member Functions
	init ()

	initADTDefinition ()
	Init adt instance. More...

	importFieldDefinition (array $a_def)
	Import (type-specific) field definition from DB. More...

	getFieldDefinition ()
	Get (type-specific) field definition. More...

	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
	Add input elements to definition form. More...

	addPropertiesToXML (ilXmlWriter $a_writer)
	Add (type-specific) properties to xml export. More...

	initADTDefinition ()
	Init adt instance. More...

	importFieldDefinition (array $a_def)
	Import (type-specific) field definition from DB. More...

	getFieldDefinition ()
	Get (type-specific) field definition. More...

	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
	Add custom input elements to definition form. More...

	addPropertiesToXML (ilXmlWriter $a_writer)
	Add (type-specific) properties to xml export. More...

Protected Member Functions inherited from ilAdvancedMDFieldDefinition
	initADTDefinition ()
	Init adt instance. More...

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

	importFieldDefinition (array $a_def)
	Import (type-specific) field definition from DB. More...

	getFieldDefinition ()
	Get (type-specific) field definition. More...

	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
	Add custom input elements to definition form. More...

	addPropertiesToXML (ilXmlWriter $a_writer)
	Add (type-specific) properties to xml export. More...

	parseSearchObjects (array $a_records, array $a_object_types)
	Add object-data needed for global search to AMD search results. More...

Protected Attributes
int	$decimals

Protected Attributes inherited from ilAdvancedMDFieldDefinitionInteger
int	$min = null

int	$max = null

string	$suffix = null

	$suffix_translations = []

Protected Attributes inherited from ilAdvancedMDFieldDefinition
GenericData	$generic_data

ilADTDefinition	$adt_def = null

ilADT	$adt = null

string	$language = ''

ilDBInterface	$db

ilLanguage	$lng

ilLogger	$logger

GlobalHttpState	$http

RefineryFactory	$refinery

Private Attributes
const	MIN_DECIMALS = 1

Additional Inherited Members
Static Public Member Functions inherited from ilAdvancedMDFieldDefinition
static	getInstance (?int $a_field_id, ?int $a_type=null, string $language='')

static	exists (int $a_field_id)

static	getInstanceByTypeString (string $a_type)
	Get instance by type string (used by import) More...

static	getInstancesByRecordId ( $a_record_id, $a_only_searchable=false, string $language='')
	Get definitions by record id. More...

static	getInstancesByObjType ($a_obj_type, $a_active_only=true)

static	getInstanceByImportId (string $a_import_id)

static	getSearchableDefinitionIds ()
	Get searchable definition ids (performance is key) More...

static	getADTGroupForDefinitions (array $a_defs)
	Init ADTGroup for definitions. More...

static	getValidTypes ()
	Get all valid types. More...

static	isValidType (int $a_type)

Data Fields inherited from ilAdvancedMDFieldDefinition
const	TYPE_SELECT = 1
	TODO: put this in when minimum php version is set to 8.2. More...

const	TYPE_TEXT = 2

const	TYPE_DATE = 3

const	TYPE_DATETIME = 4

const	TYPE_INTEGER = 5

const	TYPE_FLOAT = 6

const	TYPE_LOCATION = 7

const	TYPE_SELECT_MULTI = 8

const	TYPE_ADDRESS = 99

const	TYPE_EXTERNAL_LINK = 9

const	TYPE_INTERNAL_LINK = 10

Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static	getInstanceWithData (GenericData $generic_data, string $language='')

static	getTypeString (int $a_type)
	Get type as string. More...

Detailed Description

AMD field type float (based on integer)

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 27 of file class.ilAdvancedMDFieldDefinitionFloat.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 33 of file class.ilAdvancedMDFieldDefinitionFloat.php.

    {
        $this->init();
        parent::__construct($generic_data, $language);
    }

References ilAdvancedMDFieldDefinition\$language, ILIAS\GlobalScreen\Provider\__construct(), and init().

Here is the call graph for this function:

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

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

protected

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled
string	$language

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 118 of file class.ilAdvancedMDFieldDefinitionFloat.php.

     : void {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        // #32
        parent::addCustomFieldToDefinitionForm($a_form, $a_disabled, $language);
 
        $decimals = new ilNumberInputGUI($lng->txt("md_adv_number_decimals"), "dec");
        $decimals->setRequired(true);
        $decimals->setValue((string) $this->getDecimals());
        $decimals->setSize(5);
        $a_form->addItem($decimals);
 
        if ($a_disabled) {
            $decimals->setDisabled(true);
        }
    }

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionFloat::addPropertiesToXML ( ilXmlWriter $a_writer )

protected

Add (type-specific) properties to xml export.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

                                                                : void
    {
        parent::addPropertiesToXML($a_writer);
        $a_writer->xmlElement('FieldValue', array("id" => "decimals"), $this->getDecimals());
    }

References ilXmlWriter\xmlElement().

Here is the call graph for this function:

◆ getDecimals()

ilAdvancedMDFieldDefinitionFloat::getDecimals ( )

Get decimals.

Returns: int

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

    {
        return $this->decimals;
    }

References $decimals.

Referenced by getFieldDefinition(), getFieldDefinitionForTableGUI(), and initADTDefinition().

Here is the caller graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::getFieldDefinition ( )

protected

Get (type-specific) field definition.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 94 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                                           : array
    {
        $def = parent::getFieldDefinition();
        $def["decimals"] = $this->getDecimals();
        return $def;
    }

References getDecimals().

Here is the call graph for this function:

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionFloat::getFieldDefinitionForTableGUI ( string $content_language )

Parse properties for table gui.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 101 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                                                                           : array
    {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        $res = parent::getFieldDefinitionForTableGUI($content_language);
        $res[$lng->txt("md_adv_number_decimals")] = $this->getDecimals();
        return $res;
    }

References $DIC, ilAdvancedMDFieldDefinition\$lng, $res, getDecimals(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getType()

ilAdvancedMDFieldDefinitionFloat::getType ( )

Get type.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 39 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                             : int
    {
        return self::TYPE_FLOAT;
    }

References ilAdvancedMDFieldDefinition\TYPE_FLOAT.

◆ importCustomDefinitionFormPostValues()

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

Import custom post values from definition form.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 144 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                                                                                                          : void
    {
        parent::importCustomDefinitionFormPostValues($a_form, $language);
        $this->setDecimals((int) $a_form->getInput("dec"));
    }

References ilPropertyFormGUI\getInput().

Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::importFieldDefinition ( array $a_def )

protected

Import (type-specific) field definition from DB.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 88 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                                                          : void
    {
        parent::importFieldDefinition($a_def);
        $this->setDecimals($a_def["decimals"] ?? self::MIN_DECIMALS);
    }

References setDecimals().

Here is the call graph for this function:

◆ importXMLProperty()

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

Import property from XML.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 161 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                                                                     : void
    {
        if ($a_key == "decimals") {
            $this->setDecimals($a_value != "" ? $a_value : null);
        }
 
        parent::importXMLProperty($a_key, $a_value);
    }

◆ init()

ilAdvancedMDFieldDefinitionFloat::init ( )

protected

Definition at line 44 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                             : void
    {
        $this->setDecimals(2);
    }

References setDecimals().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionFloat::initADTDefinition ( )

protected

Init adt instance.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

                                          : ilADTDefinition
    {
        $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Float");
 
        $def->setMin($this->getMin());
        $def->setMax($this->getMax());
        $def->setDecimals($this->getDecimals());
        $def->setSuffix($this->getSuffixTranslations()[$this->language] ?? $this->getSuffix());
        return $def;
    }

References getDecimals(), ilADTFactory\getInstance(), ilAdvancedMDFieldDefinitionInteger\getMax(), ilAdvancedMDFieldDefinitionInteger\getMin(), ilAdvancedMDFieldDefinitionInteger\getSuffix(), ilAdvancedMDFieldDefinitionInteger\getSuffixTranslations(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ isFilterSupported()

ilAdvancedMDFieldDefinitionFloat::isFilterSupported ( )

Is search by filter supported.

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

Definition at line 49 of file class.ilAdvancedMDFieldDefinitionFloat.php.

                                       : bool
    {
        return false;
    }

◆ setDecimals()

ilAdvancedMDFieldDefinitionFloat::setDecimals ( $a_value )

Set decimals.

Parameters

int $a_value

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

    {
        $this->decimals = max(self::MIN_DECIMALS, abs((int) $a_value));
    }

Referenced by importFieldDefinition(), and init().

Here is the caller graph for this function:

Field Documentation

◆ $decimals

int ilAdvancedMDFieldDefinitionFloat::$decimals

protected

Definition at line 31 of file class.ilAdvancedMDFieldDefinitionFloat.php.

Referenced by getDecimals().

◆ MIN_DECIMALS

const ilAdvancedMDFieldDefinitionFloat::MIN_DECIMALS = 1

private

Definition at line 29 of file class.ilAdvancedMDFieldDefinitionFloat.php.

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

components/ILIAS/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionFloat.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

◆ addPropertiesToXML()

◆ getDecimals()

◆ getFieldDefinition()

◆ getFieldDefinitionForTableGUI()

◆ getType()

◆ importCustomDefinitionFormPostValues()

◆ importFieldDefinition()

◆ importXMLProperty()

◆ init()

◆ initADTDefinition()

◆ isFilterSupported()

◆ setDecimals()

Field Documentation

◆ $decimals

◆ MIN_DECIMALS