Inheritance diagram for ilADTLocalizedText:

Collaboration diagram for ilADTLocalizedText:

Public Member Functions
	getTextForLanguage (string $language)

	getTranslations ()

	setTranslation (string $language, string $translation)

	equals (ilADT $a_adt)
	@inheritDoc More...

	isLarger (ilADT $a_adt)
	@inheritDoc More...

	isSmaller (ilADT $a_adt)
	@inheritDoc More...

	isNull ()
	@inheritDoc More...

	getCheckSum ()
	@inheritDoc More...

	exportStdClass ()
	@inheritDoc More...

	importStdClass (?stdClass $a_std)
	@inheritDoc More...

Public Member Functions inherited from ilADTText
	reset ()
	Init property defaults. More...

	setText (?string $a_value=null)

	getText ()

	getLength ()

	equals (ilADT $a_adt)
	Check if given ADT equals self. More...

	isLarger (ilADT $a_adt)
	Check if given ADT is larger than self. More...

	isSmaller (ilADT $a_adt)
	Check if given ADT is smaller than self. More...

	isNull ()
	Is currently null. More...

	isValid ()

	getCheckSum ()
	Get unique checksum. More...

	exportStdClass ()
	Export value as stdClass. More...

	importStdClass (?stdClass $a_std)
	Import value from stdClass. More...

Public Member Functions inherited from ilADT
	__construct (ilADTDefinition $a_def)

	getType ()
	Get type (from class/instance) More...

	reset ()
	Init property defaults. More...

	getCopyOfDefinition ()
	Get copy of definition. More...

	equals (ilADT $a_adt)
	Check if given ADT equals self. More...

	isLarger (ilADT $a_adt)
	Check if given ADT is larger than self. More...

	isLargerOrEqual (ilADT $a_adt)

	isSmaller (ilADT $a_adt)
	Check if given ADT is smaller than self. More...

	isSmallerOrEqual (ilADT $a_adt)
	Check if given ADT is smaller or equal than self. More...

	isInbetween (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (exclusive) More...

	isInbetweenOrEqual (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (inclusive) More...

	isNull ()
	Is currently null. More...

	isValid ()

	getValidationErrors ()
	Get all validation error codes. More...

	translateErrorCode (string $a_code)
	Translate error-code to human-readable message. More...

	getCheckSum ()
	Get unique checksum. More...

	exportStdClass ()
	Export value as stdClass. More...

	importStdClass (?stdClass $a_std)
	Import value from stdClass. More...

Protected Member Functions
	isValidDefinition (ilADTDefinition $a_def)
	@inheritDoc More...

	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT. More...

Protected Member Functions inherited from ilADT
	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT. More...

	setDefinition (ilADTDefinition $a_def)
	Set definition. More...

	getDefinition ()
	Get definition. More...

	addValidationError (string $a_error_code)

Private Attributes
array	$translations = []

Additional Inherited Members
Data Fields inherited from ilADT
const	ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED = "adt1"

const	ADT_VALIDATION_ERROR_MAX_LENGTH = "adt2"

const	ADT_VALIDATION_ERROR_MAX_SIZE = "adt3"

const	ADT_VALIDATION_ERROR_MIN = "adt4"

const	ADT_VALIDATION_ERROR_MAX = "adt5"

const	ADT_VALIDATION_DATE = "adt6"

const	ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'

Protected Attributes inherited from ilADTText
string	$value

Protected Attributes inherited from ilADT
ilADTDefinition	$definition

ilLanguage	$lng

array	$validation_errors = []

Detailed Description

Class ilADTLocalizedText.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilADTLocalizedText.php.

Member Function Documentation

◆ equals()

ilADTLocalizedText::equals ( ilADT $a_adt )

@inheritDoc

Reimplemented from ilADTText.

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

                                        : ?bool
    {
        if (!$this->getDefinition()->isComparableTo($a_adt)) {
            return null;
        }
        if ($this->getTranslations() != count($a_adt->getTranslations())) {
            return false;
        }
        foreach ($a_adt->getTranslations() as $key => $value) {
            if (!isset($this->getTranslations()[$key])) {
                return false;
            }
            if (!strcmp($this->getTranslations()[$key], $value)) {
                return false;
            }
        }
        return true;
    }

References ILIAS\LTI\ToolProvider\$key, ilADTText\$value, ilADT\getDefinition(), and getTranslations().

Here is the call graph for this function:

◆ exportStdClass()

ilADTLocalizedText::exportStdClass ( )

@inheritDoc

Reimplemented from ilADTText.

Definition at line 125 of file class.ilADTLocalizedText.php.

                                    : ?stdClass
    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->translations = $this->getTranslations();
            return $obj;
        }
        return null;
    }

References getTranslations(), and isNull().

Here is the call graph for this function:

◆ getCheckSum()

ilADTLocalizedText::getCheckSum ( )

@inheritDoc

Reimplemented from ilADTText.

Definition at line 114 of file class.ilADTLocalizedText.php.

                                 : ?string
    {
        if (!$this->isNull()) {
            return md5(serialize($this->getTranslations()));
        }
        return null;
    }

References getTranslations(), and isNull().

Here is the call graph for this function:

◆ getTextForLanguage()

ilADTLocalizedText::getTextForLanguage ( string $language )

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

                                                        : string
    {
        if (array_key_exists($language, $this->getTranslations()) && strlen($this->getTranslations()[$language])) {
            return $this->getTranslations()[$language];
        }
        return (string) $this->getText();
    }

References ilADTText\getText(), and getTranslations().

Here is the call graph for this function:

◆ getTranslations()

ilADTLocalizedText::getTranslations ( )

Returns: array

Definition at line 40 of file class.ilADTLocalizedText.php.

                                     : array
    {
        return $this->translations;
    }

References $translations.

Referenced by equals(), exportStdClass(), getCheckSum(), getTextForLanguage(), and isNull().

Here is the caller graph for this function:

◆ importStdClass()

ilADTLocalizedText::importStdClass ( ?stdClass $a_std )

@inheritDoc

Reimplemented from ilADTText.

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

                                                    : void
    {
        if (is_object($a_std)) {
            $this->translations = $a_std->translations;
        }
    }

◆ isLarger()

ilADTLocalizedText::isLarger ( ilADT $a_adt )

@inheritDoc

Reimplemented from ilADTText.

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

                                          : ?bool
    {
        return null;
    }

◆ isNull()

ilADTLocalizedText::isNull ( )

@inheritDoc

Reimplemented from ilADTText.

Definition at line 99 of file class.ilADTLocalizedText.php.

                            : bool
    {
        $has_translation = false;
        foreach ($this->getTranslations() as $translation) {
            if ($translation !== '') {
                $has_translation = true;
                break;
            }
        }
        return !$this->getLength() && !$has_translation;
    }

References ilADTText\getLength(), and getTranslations().

Referenced by exportStdClass(), and getCheckSum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTLocalizedText::isSmaller ( ilADT $a_adt )

@inheritDoc

Reimplemented from ilADTText.

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

                                           : ?bool
    {
        return null;
    }

◆ isValidDefinition()

ilADTLocalizedText::isValidDefinition ( ilADTDefinition $a_def )

protected

@inheritDoc

Reimplemented from ilADTText.

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

                                                                : bool
    {
        return $a_def instanceof ilADTLocalizedTextDefinition;
    }

◆ setTranslation()

ilADTLocalizedText::setTranslation	(	string	$language,
		string	$translation
	)

Definition at line 45 of file class.ilADTLocalizedText.php.

                                                                         : void
    {
        $this->translations[$language] = $translation;
    }

Field Documentation

◆ $translations

array ilADTLocalizedText::$translations = []

private

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

Referenced by getTranslations().

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

Services/ADT/classes/Types/LocalizedText/class.ilADTLocalizedText.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getTextForLanguage()

◆ getTranslations()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValidDefinition()

◆ setTranslation()

Field Documentation

◆ $translations