Inheritance diagram for ilADTLocalizedText:

Collaboration diagram for ilADTLocalizedText:

Public Member Functions
	getTextForLanguage (string $language)

	getTranslations ()

	setTranslation (string $language, string $translation)

	reset ()

	equals (ilADT $a_adt)

	isLarger (ilADT $a_adt)

	isSmaller (ilADT $a_adt)

	isNull ()

	getCheckSum ()

	exportStdClass ()

	importStdClass (?stdClass $a_std)

Public Member Functions inherited from ilADTText
	reset ()

	setText (?string $a_value=null)

	getText ()

	getLength ()

	equals (ilADT $a_adt)

	isLarger (ilADT $a_adt)

	isSmaller (ilADT $a_adt)

	isNull ()

	isValid ()

	getCheckSum ()

	exportStdClass ()

	importStdClass (?stdClass $a_std)

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)

Protected Member Functions inherited from ilADTText
	isValidDefinition (ilADTDefinition $a_def)

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 )

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

References ilADTText\$value, ilADT\getDefinition(), getTranslations(), and null.

                                         : ?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;
     }

Here is the call graph for this function:

◆ exportStdClass()

ilADTLocalizedText::exportStdClass ( )

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

References getTranslations(), isNull(), and null.

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

Here is the call graph for this function:

◆ getCheckSum()

ilADTLocalizedText::getCheckSum ( )

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

References getTranslations(), isNull(), and null.

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

Here is the call graph for this function:

◆ getTextForLanguage()

ilADTLocalizedText::getTextForLanguage ( string $language )

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

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

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

Here is the call graph for this function:

◆ getTranslations()

ilADTLocalizedText::getTranslations ( )

Returns: array

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

References $translations.

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

                                      : array
     {
         return $this->translations;
     }

Here is the caller graph for this function:

◆ importStdClass()

ilADTLocalizedText::importStdClass ( ?stdClass $a_std )

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

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

◆ isLarger()

ilADTLocalizedText::isLarger ( ilADT $a_adt )

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

References null.

                                           : ?bool
     {
         return null;
     }

◆ isNull()

ilADTLocalizedText::isNull ( )

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

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

Referenced by exportStdClass(), and getCheckSum().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTLocalizedText::isSmaller ( ilADT $a_adt )

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

References null.

                                            : ?bool
     {
         return null;
     }

◆ isValidDefinition()

ilADTLocalizedText::isValidDefinition ( ilADTDefinition $a_def )

protected

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

                                                                 : bool
     {
         return $a_def instanceof ilADTLocalizedTextDefinition;
     }

◆ reset()

ilADTLocalizedText::reset ( )

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

                            : void
     {
         parent::reset();
         $this->translations = [];
     }

◆ 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:

components/ILIAS/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()

◆ reset()

◆ setTranslation()

Field Documentation

◆ $translations