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

Inheritance diagram for ilAdvancedMDFieldDefinitionFloat:

Collaboration diagram for ilAdvancedMDFieldDefinitionFloat:

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

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

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

	importXMLProperty ($a_key, $a_value)

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 ($a_value)
	Set min. More...

	getMin ()
	Get min. More...

	setMax ($a_value)
	Set max. More...

	getMax ()
	Get max. More...

	setSuffix ($a_value)
	Set suffix. More...

	getSuffix ()
	Get suffix. More...

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

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

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

	importXMLProperty ($a_key, $a_value)

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

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

Public Member Functions inherited from ilAdvancedMDFieldDefinition
	__construct ($a_field_id=null, string $language='')
	Constructor. More...

	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 ()
	Get type title (lang id) More...

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

	getADT ()
	Get ADT instance. More...

	getFieldId ()
	Get field_id. More...

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

	getRecordId ()
	Get record id. More...

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

	getImportId ()
	Get import id. More...

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

	getPosition ()
	Get position. More...

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

	getTitle ()
	Get title. More...

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

	getDescription ()
	Get description. More...

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

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

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

	isSearchable ()
	Is searchable. More...

	setRequired ($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 ($a_field_id)
	Generate unique record id. More...

	save ($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 ($a_key, $a_value)
	Import property from XML. More...

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

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

	importFromECS ($a_ecs_type, $a_value, $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)
	Get value for search persistence. More...

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

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

	searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, $a_locate, $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 ($a_new_record_id)
	Clone field definition. More...

	hasComplexOptions ()

	getComplexOptionsOverview ($a_parent_gui, string $parent_cmd)

Protected Member Functions
	init ()
	Init properties. More...

	initADTDefinition ()

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

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

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

	initADTDefinition ()

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

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

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

Protected Member Functions inherited from ilAdvancedMDFieldDefinition
	init ()
	Init properties. More...

	initADTDefinition ()
	Init adt instance. More...

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

	setFieldId ($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, $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 ($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...

Protected Attributes
	$decimals

Protected Attributes inherited from ilAdvancedMDFieldDefinitionInteger
	$min

	$max

	$suffix

	$suffix_translations = []

Protected Attributes inherited from ilAdvancedMDFieldDefinition
	$field_id

	$record_id

	$import_id

	$position

	$title

	$description

	$searchable

	$required

	$adt_def

	$adt

	$language = ''

	$logger

Additional Inherited Members
Static Public Member Functions inherited from ilAdvancedMDFieldDefinition
static	getInstance ($a_field_id, $a_type=null, string $language='')
	Get definition instance by type. More...

static	exists ($a_field_id)
	Check if field exists. More...

static	getInstanceByTypeString ($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 ($a_import_id)
	Get definition instance by import id. More...

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 ($a_type)
	Is given type valid. More...

Data Fields inherited from ilAdvancedMDFieldDefinition
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

Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static	getTypeString ($a_type)
	Get type 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

Version: $Id$

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

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

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

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled
string	$language

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

    {
        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($this->getDecimals());
        $decimals->setSize(5);
        $a_form->addItem($decimals);
        
        if ($a_disabled) {
            $decimals->setDisabled(true);
        }
    }

References $decimals, $DIC, ilAdvancedMDFieldDefinition\$language, $lng, ilPropertyFormGUI\addItem(), and getDecimals().

Here is the call graph for this function:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionFloat::addPropertiesToXML ( ilXmlWriter $a_writer )

protected

Add (type-specific) properties to xml export.

Parameters

ilXmlWriter $a_writer

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

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

References getDecimals(), and ilXmlWriter\xmlElement().

Here is the call graph for this function:

◆ getDecimals()

ilAdvancedMDFieldDefinitionFloat::getDecimals ( )

Get decimals.

Returns: int

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

    {
        return $this->decimals;
    }

References $decimals.

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

Here is the caller graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::getFieldDefinition ( )

protected

Get (type-specific) field definition.

Returns: array

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

    {
        $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.

Returns: array

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

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

References $DIC, $lng, $res, and getDecimals().

Here is the call graph for this function:

◆ getType()

ilAdvancedMDFieldDefinitionFloat::getType ( )

Get type.

Returns: int

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

    {
        return self::TYPE_FLOAT;
    }

References ilAdvancedMDFieldDefinition\TYPE_FLOAT.

◆ importCustomDefinitionFormPostValues()

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

Import custom post values from definition form.

Parameters

ilPropertyFormGUI	$a_form
string	$language

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

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

References ilAdvancedMDFieldDefinition\$language, ilPropertyFormGUI\getInput(), and setDecimals().

Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::importFieldDefinition ( array $a_def )

protected

Import (type-specific) field definition from DB.

Parameters

array $a_def

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

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

References setDecimals().

Here is the call graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinitionFloat::importXMLProperty	(	$a_key,
		$a_value
	)

Parameters

string	$a_key
string	$a_value

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

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

References setDecimals().

Here is the call graph for this function:

◆ init()

ilAdvancedMDFieldDefinitionFloat::init ( )

protected

Init properties.

Reimplemented from ilAdvancedMDFieldDefinition.

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

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

References setDecimals().

Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionFloat::initADTDefinition ( )

protected

Returns: ilADTDefinition

Exceptions

Exception

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

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

References getDecimals(), ilADTFactory\getInstance(), ilAdvancedMDFieldDefinitionInteger\getMax(), ilAdvancedMDFieldDefinitionInteger\getMin(), ilAdvancedMDFieldDefinitionInteger\getSuffix(), ilAdvancedMDFieldDefinitionInteger\getSuffixTranslations(), and language().

Here is the call graph for this function:

◆ isFilterSupported()

ilAdvancedMDFieldDefinitionFloat::isFilterSupported ( )

Is search by filter supported.

Returns: boolean

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

    {
        return false;
    }

◆ setDecimals()

ilAdvancedMDFieldDefinitionFloat::setDecimals ( $a_value )

Set decimals.

Parameters

int $a_value

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

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

Referenced by importCustomDefinitionFormPostValues(), importFieldDefinition(), importXMLProperty(), and init().

Here is the caller graph for this function:

Field Documentation

◆ $decimals

ilAdvancedMDFieldDefinitionFloat::$decimals

protected

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

Referenced by addCustomFieldToDefinitionForm(), and getDecimals().

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

Services/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionFloat.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

◆ addPropertiesToXML()

◆ getDecimals()

◆ getFieldDefinition()

◆ getFieldDefinitionForTableGUI()

◆ getType()

◆ importCustomDefinitionFormPostValues()

◆ importFieldDefinition()

◆ importXMLProperty()

◆ init()

◆ initADTDefinition()

◆ isFilterSupported()

◆ setDecimals()

Field Documentation

◆ $decimals