ilAdvancedMDFieldDefinitionInteger Class Reference

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 (?int $a_value)
	getMin ()
	setMax (?int $a_value)
	getMax ()
	setSuffix (?string $a_value)
	getSuffix ()
	getFieldDefinitionForTableGUI (string $content_language)
	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
	importXMLProperty (string $a_key, string $a_value)
	getValueForXML (ilADT $element)
	importValueFromXML (string $a_cdata)
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
	initADTDefinition ()
	importFieldDefinition (array $a_def)
	getFieldDefinition ()
	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
	addPropertiesToXML (ilXmlWriter $a_writer)
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	$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

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 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 26 of file class.ilAdvancedMDFieldDefinitionInteger.php.

Member Function Documentation

addCustomFieldToDefinitionForm()

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

protected

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

References ilAdvancedMDFieldDefinition\$language, ilAdvancedMDRecord\_getInstanceByRecordId(), ilPropertyFormGUI\addItem(), getMax(), getMin(), ilAdvancedMDFieldDefinition\getRecordId(), getSuffix(), getSuffixTranslations(), ILIAS\Repository\lng(), ilNumberInputGUI\setValue(), and ilAdvancedMDFieldDefinition\useDefaultLanguageMode().

     : void {
        $min = new ilNumberInputGUI($this->lng->txt("md_adv_number_min"), "min");
        $min->setValue((string) $this->getMin());
        $min->setSize(10);
        $a_form->addItem($min);

        $max = new ilNumberInputGUI($this->lng->txt("md_adv_number_max"), "max");
        $max->setValue((string) $this->getMax());
        $max->setSize(10);
        $a_form->addItem($max);

        $suffix = new ilTextInputGUI($this->lng->txt("md_adv_number_suffix"), "suffix");
        if ($this->useDefaultLanguageMode($language)) {
            $suffix->setValue($this->getSuffix());
        } else {
            $default_language = ilAdvancedMDRecord::_getInstanceByRecordId(
                $this->getRecordId()
            )->getDefaultLanguage();
            $suffix->setInfo($default_language . ': ' . $this->getSuffix());
            $suffix->setValue($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 205 of file class.ilAdvancedMDFieldDefinitionInteger.php.

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

                                                                : void
    {
        $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 122 of file class.ilAdvancedMDFieldDefinitionInteger.php.

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

                                           : array
    {
        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 132 of file class.ilAdvancedMDFieldDefinitionInteger.php.

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

                                                                           : array
    {
        $res = [];

        if ($this->getMin() !== null) {
            $res[$this->lng->txt("md_adv_number_min")] = $this->getMin();
        }
        if ($this->getMax() !== null) {
            $res[$this->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[$this->lng->txt("md_adv_number_suffix")] = $suffix;
        }
        return $res;
    }

Here is the call graph for this function:

getMax()

ilAdvancedMDFieldDefinitionInteger::getMax

(

)

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

References $max.

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

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

Here is the caller graph for this function:

getMin()

ilAdvancedMDFieldDefinitionInteger::getMin

(

)

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

References $min.

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

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

Here is the caller graph for this function:

getSuffix()

ilAdvancedMDFieldDefinitionInteger::getSuffix

(

)

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

References $suffix.

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

                               : ?string
    {
        return $this->suffix;
    }

Here is the caller graph for this function:

getSuffixTranslations()

ilAdvancedMDFieldDefinitionInteger::getSuffixTranslations

(

)

Returns

array<string, string>

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

References $suffix_translations.

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

                                           : array
    {
        return $this->suffix_translations;
    }

Here is the caller graph for this function:

getType()

ilAdvancedMDFieldDefinitionInteger::getType

(

)

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

                             : int
    {
        return self::TYPE_INTEGER;
    }

getValueForXML()

ilAdvancedMDFieldDefinitionInteger::getValueForXML

(

ilADT

$element

)

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

                                                  : string
    {
        return (string) $element->getNumber();
    }

importCustomDefinitionFormPostValues()

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

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

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

                                                                                                          : void
    {
        $min = $a_form->getInput("min");
        $this->setMin(($min !== "" && !is_null($min)) ? (int) $min : null);

        $max = $a_form->getInput("max");
        $this->setMax(($max !== "" && !is_null($max)) ? (int) $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 114 of file class.ilAdvancedMDFieldDefinitionInteger.php.

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

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

Here is the call graph for this function:

importValueFromXML()

ilAdvancedMDFieldDefinitionInteger::importValueFromXML

(

string

$a_cdata

)

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

References ilAdvancedMDFieldDefinition\getADT().

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

Here is the call graph for this function:

importXMLProperty()

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

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

References $parts, null, setMax(), setMin(), setSuffix(), and setSuffixTranslation().

                                                                     : void
    {
        if ($a_key == "min") {
            $this->setMin($a_value != "" ? (int) $a_value : null);
            return;
        }
        if ($a_key == "max") {
            $this->setMax($a_value != "" ? (int) $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

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

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

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

Here is the call graph for this function:

isFilterSupported()

ilAdvancedMDFieldDefinitionInteger::isFilterSupported

(

)

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

                                       : bool
    {
        return false;
    }

setMax()

ilAdvancedMDFieldDefinitionInteger::setMax

(

?int

$a_value

)

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

References null.

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

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

Here is the caller graph for this function:

setMin()

ilAdvancedMDFieldDefinitionInteger::setMin

(

?int

$a_value

)

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

References null.

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

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

Here is the caller graph for this function:

setSuffix()

ilAdvancedMDFieldDefinitionInteger::setSuffix

(

?string

$a_value

)

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

References null.

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

                                               : void
    {
        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
	)

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

References ilAdvancedMDFieldDefinition\$language, and $suffix.

Referenced by importCustomDefinitionFormPostValues(), and importXMLProperty().

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

Here is the caller graph for this function:

setSuffixTranslations()

ilAdvancedMDFieldDefinitionInteger::setSuffixTranslations

(

array

$suffix_translations

)

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

References $suffix_translations.

Referenced by importFieldDefinition().

                                                                     : void
    {
        $this->suffix_translations = $suffix_translations;
    }

Here is the caller graph for this function:

Field Documentation

$max

int ilAdvancedMDFieldDefinitionInteger::$max = null

protected

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

Referenced by getMax().

$min

int ilAdvancedMDFieldDefinitionInteger::$min = null

protected

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

Referenced by getMin().

$suffix

string ilAdvancedMDFieldDefinitionInteger::$suffix = null

protected

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

Referenced by getFieldDefinitionForTableGUI(), getSuffix(), and setSuffixTranslation().

$suffix_translations

ilAdvancedMDFieldDefinitionInteger::$suffix_translations = []

protected

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

Referenced by getSuffixTranslations(), and setSuffixTranslations().

---

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

• components/ILIAS/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionInteger.php