AMD field type integer. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionInteger:

Collaboration diagram for ilAdvancedMDFieldDefinitionInteger:

Public Member Functions
	getType ()

	isFilterSupported ()

	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)

	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)

	importValueFromXML ($a_cdata)

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

	importFieldDefinition (array $a_def)

	getFieldDefinition ()

	addPropertiesToXML (ilXmlWriter $a_writer)

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
	$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 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.ilAdvancedMDFieldDefinitionInteger.php.

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

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

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled
string	$language

Definition at line 207 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $DIC, ilAdvancedMDFieldDefinition\$language, $lng, $max, $min, $suffix, ilAdvancedMDRecord\_getInstanceByRecordId(), ilPropertyFormGUI\addItem(), getMax(), getMin(), getSuffix(), getSuffixTranslations(), and ilAdvancedMDFieldDefinition\useDefaultLanguageMode().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         
         $min = new ilNumberInputGUI($lng->txt("md_adv_number_min"), "min");
         $min->setValue($this->getMin());
         $min->setSize(10);
         $a_form->addItem($min);
         
         $max = new ilNumberInputGUI($lng->txt("md_adv_number_max"), "max");
         $max->setValue($this->getMax());
         $max->setSize(10);
         $a_form->addItem($max);
         
         $suffix = new ilTextInputGUI($lng->txt("md_adv_number_suffix"), "suffix");
         if ($this->useDefaultLanguageMode($language)) {
             $suffix->setValue($this->getSuffix());
         } else {
             $default_language = ilAdvancedMDRecord::_getInstanceByRecordId($this->record_id)->getDefaultLanguage();
             $suffix->setInfo($default_language . ': ' . $this->getSuffix());
             $suffix->setValue(isset($this->getSuffixTranslations()[$language]) ? $this->getSuffixTranslations()[$language] : '');
         }
         $suffix->setSize(10);
         $a_form->addItem($suffix);
                 
         if ($a_disabled) {
             $min->setDisabled(true);
             $max->setDisabled(true);
             $suffix->setDisabled(true);
         }
     }

Here is the call graph for this function:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionInteger::addPropertiesToXML ( ilXmlWriter $a_writer )

protected

Definition at line 264 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $suffix, getMax(), getMin(), getSuffix(), getSuffixTranslations(), and ilXmlWriter\xmlElement().

     {
         $a_writer->xmlElement('FieldValue', array("id" => "min"), $this->getMin());
         $a_writer->xmlElement('FieldValue', array("id" => "max"), $this->getMax());
         $a_writer->xmlElement('FieldValue', array("id" => "suffix"), $this->getSuffix());
 
         foreach ($this->getSuffixTranslations() as $lang_key => $suffix) {
             $a_writer->xmlElement('FieldValue', ['id' => 'suffix_' . $lang_key], $suffix);
         }
     }

Here is the call graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionInteger::getFieldDefinition ( )

protected

Definition at line 165 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References getMax(), getMin(), getSuffix(), and getSuffixTranslations().

     {
         return array(
             "min" => $this->getMin(),
             "max" => $this->getMax(),
             "suffix" => $this->getSuffix(),
             'suffix_translations' => $this->getSuffixTranslations()
         );
     }

Here is the call graph for this function:

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionInteger::getFieldDefinitionForTableGUI ( string $content_language )

Definition at line 175 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $DIC, $lng, $res, $suffix, getMax(), getMin(), getSuffix(), getSuffixTranslations(), and ilAdvancedMDFieldDefinition\useDefaultLanguageMode().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
     
         $res = array();
         
         if ($this->getMin() !== null) {
             $res[$lng->txt("md_adv_number_min")] = $this->getMin();
         }
         if ($this->getMax() !== null) {
             $res[$lng->txt("md_adv_number_max")] = $this->getMax();
         }
         if ($this->getSuffix()) {
             if ($this->useDefaultLanguageMode($content_language)) {
                 $suffix = $this->getSuffix();
             } else {
                 $suffix = $this->getSuffixTranslations()[$content_language] ?? '';
             }
             $res[$lng->txt("md_adv_number_suffix")] = $suffix;
         }
         
         return $res;
     }

Here is the call graph for this function:

◆ getMax()

ilAdvancedMDFieldDefinitionInteger::getMax ( )

Get max.

Returns: int

Definition at line 124 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $max.

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

     {
         return $this->max;
     }

Here is the caller graph for this function:

◆ getMin()

ilAdvancedMDFieldDefinitionInteger::getMin ( )

Get min.

Returns: int

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

References $min.

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

     {
         return $this->min;
     }

Here is the caller graph for this function:

◆ getSuffix()

ilAdvancedMDFieldDefinitionInteger::getSuffix ( )

Get suffix.

Returns: string

Definition at line 147 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $suffix.

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

     {
         return $this->suffix;
     }

Here is the caller graph for this function:

◆ getSuffixTranslations()

ilAdvancedMDFieldDefinitionInteger::getSuffixTranslations ( )

Returns: array

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

References $suffix_translations.

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

     {
         return $this->suffix_translations;
     }

Here is the caller graph for this function:

◆ getType()

ilAdvancedMDFieldDefinitionInteger::getType ( )

Definition at line 26 of file class.ilAdvancedMDFieldDefinitionInteger.php.

     {
         return self::TYPE_INTEGER;
     }

◆ getValueForXML()

ilAdvancedMDFieldDefinitionInteger::getValueForXML ( ilADT $element )

Definition at line 300 of file class.ilAdvancedMDFieldDefinitionInteger.php.

     {
         return $element->getNumber();
     }

◆ importCustomDefinitionFormPostValues()

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

Import custom post values from definition form.

Parameters

ilPropertyFormGUI	$a_form
string	$language

Definition at line 246 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References ilAdvancedMDFieldDefinition\$language, $max, $min, $suffix, ilPropertyFormGUI\getInput(), setMax(), setMin(), setSuffix(), setSuffixTranslation(), and ilAdvancedMDFieldDefinition\useDefaultLanguageMode().

     {
         $min = $a_form->getInput("min");
         $this->setMin(($min !== "") ? $min : null);
         
         $max = $a_form->getInput("max");
         $this->setMax(($max !== "") ? $max : null);
 
         if ($this->useDefaultLanguageMode($language)) {
             $suffix = $a_form->getInput("suffix");
             $this->setSuffix(($suffix !== "") ? $suffix : null);
         } else {
             $suffix = $a_form->getInput('suffix');
             $this->setSuffixTranslation($language, $suffix);
         }
     }

Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionInteger::importFieldDefinition ( array $a_def )

protected

Definition at line 157 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References setMax(), setMin(), setSuffix(), and setSuffixTranslations().

     {
         $this->setMin($a_def["min"]);
         $this->setMax($a_def["max"]);
         $this->setSuffix($a_def["suffix"]);
         $this->setSuffixTranslations(isset($a_def['suffix_translations']) ? $a_def['suffix_translations'] : []);
     }

Here is the call graph for this function:

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionInteger::importValueFromXML ( $a_cdata )

Definition at line 305 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References ilAdvancedMDFieldDefinition\getADT().

     {
         $this->getADT()->setNumber($a_cdata);
     }

Here is the call graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinitionInteger::importXMLProperty	(	$a_key,
		$a_value
	)

Parameters

string	$a_key
string	$a_value

Definition at line 279 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References setMax(), setMin(), setSuffix(), and setSuffixTranslation().

     {
         if ($a_key == "min") {
             $this->setMin($a_value != "" ? $a_value : null);
             return;
         }
         if ($a_key == "max") {
             $this->setMax($a_value != "" ? $a_value : null);
             return;
         }
         if ($a_key == "suffix") {
             $this->setSuffix($a_value != "" ? $a_value : null);
             return;
         }
 
         $parts = explode('_',$a_key);
         if (isset($parts[0]) && $parts[0] == 'suffix') {
             $this->setSuffixTranslation($parts[1], $a_value);
         }
     }

Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionInteger::initADTDefinition ( )

protected

Returns: ilADTDefinition

Exceptions

Exception

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

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

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

Here is the call graph for this function:

◆ isFilterSupported()

ilAdvancedMDFieldDefinitionInteger::isFilterSupported ( )

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

     {
         return false;
     }

◆ setMax()

ilAdvancedMDFieldDefinitionInteger::setMax ( $a_value )

Set max.

Parameters

int $a_value

Definition at line 111 of file class.ilAdvancedMDFieldDefinitionInteger.php.

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

     {
         if ($a_value !== null) {
             $a_value = (int) $a_value;
         }
         $this->max = $a_value;
     }

Here is the caller graph for this function:

◆ setMin()

ilAdvancedMDFieldDefinitionInteger::setMin ( $a_value )

Set min.

Parameters

int $a_value

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

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

     {
         if ($a_value !== null) {
             $a_value = (int) $a_value;
         }
         $this->min = $a_value;
     }

Here is the caller graph for this function:

◆ setSuffix()

ilAdvancedMDFieldDefinitionInteger::setSuffix ( $a_value )

Set suffix.

Parameters

string $a_value

Definition at line 134 of file class.ilAdvancedMDFieldDefinitionInteger.php.

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

     {
         if ($a_value !== null) {
             $a_value = trim($a_value);
         }
         $this->suffix = $a_value;
     }

Here is the caller graph for this function:

◆ setSuffixTranslation()

ilAdvancedMDFieldDefinitionInteger::setSuffixTranslation	(	string	$language,
		string	$suffix
	)

Parameters

string	$language
string	$suffix

Definition at line 48 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References ilAdvancedMDFieldDefinition\$language, and $suffix.

Referenced by importCustomDefinitionFormPostValues(), and importXMLProperty().

     {
         $this->suffix_translations[$language] = $suffix;
     }

Here is the caller graph for this function:

◆ setSuffixTranslations()

ilAdvancedMDFieldDefinitionInteger::setSuffixTranslations ( array $suffix_translations )

Parameters

array $suffix_translations

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

References $suffix_translations.

Referenced by importFieldDefinition().

     {
         $this->suffix_translations = $suffix_translations;
     }

Here is the caller graph for this function:

Field Documentation

◆ $max

ilAdvancedMDFieldDefinitionInteger::$max

protected

Definition at line 17 of file class.ilAdvancedMDFieldDefinitionInteger.php.

Referenced by addCustomFieldToDefinitionForm(), getMax(), and importCustomDefinitionFormPostValues().

◆ $min

ilAdvancedMDFieldDefinitionInteger::$min

protected

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

Referenced by addCustomFieldToDefinitionForm(), getMin(), and importCustomDefinitionFormPostValues().

◆ $suffix

ilAdvancedMDFieldDefinitionInteger::$suffix

protected

Definition at line 18 of file class.ilAdvancedMDFieldDefinitionInteger.php.

Referenced by addCustomFieldToDefinitionForm(), addPropertiesToXML(), getFieldDefinitionForTableGUI(), getSuffix(), importCustomDefinitionFormPostValues(), and setSuffixTranslation().

◆ $suffix_translations

ilAdvancedMDFieldDefinitionInteger::$suffix_translations = []

protected

Definition at line 20 of file class.ilAdvancedMDFieldDefinitionInteger.php.

Referenced by getSuffixTranslations(), and setSuffixTranslations().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

◆ addPropertiesToXML()

◆ getFieldDefinition()

◆ getFieldDefinitionForTableGUI()

◆ getMax()

◆ getMin()

◆ getSuffix()

◆ getSuffixTranslations()

◆ getType()

◆ getValueForXML()

◆ importCustomDefinitionFormPostValues()

◆ importFieldDefinition()

◆ importValueFromXML()

◆ importXMLProperty()

◆ initADTDefinition()

◆ isFilterSupported()

◆ setMax()

◆ setMin()

◆ setSuffix()

◆ setSuffixTranslation()

◆ setSuffixTranslations()

Field Documentation

◆ $max

◆ $min

◆ $suffix

◆ $suffix_translations