Collaboration diagram for ILIAS\ILIASObject\Properties\Translations\Language:

Public Member Functions
	__construct (private readonly string $language_code, private string $title, private string $description, private bool $default=false, private bool $base=false)

	getLanguageCode ()

	getTitle ()

	withTitle (string $title)

	getDescription ()

	withDescription (string $description)

	isDefault ()

	withDefault (bool $default)

	isBase ()

	withBase (bool $base)

	toForm (\ilLanguage $language, FieldFactory $field_factory, Refinery $refinery)

	toRow (DataRowBuilder $row_builder, SystemLanguage $lng)

	getDisplayValueForKey (SystemLanguage $lng, string $key)

Data Fields
const	KEY_LANGUAGE = 'language'

const	KEY_BASE = 'base'

const	KEY_DEFAULT = 'default'

const	KEY_TITLE = 'title'

const	KEY_DESCRIPTION = 'description'

Private Member Functions
	getTranslatedLanguageName (SystemLanguage $lng, string $language_code)

Detailed Description

Definition at line 29 of file Language.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ILIASObject\Properties\Translations\Language::__construct	(	private readonly string	$language_code,
		private string	$title,
		private string	$description,
		private bool	$default = `false`,
		private bool	$base = `false`
	)

Definition at line 37 of file Language.php.

43 {

44 }

Member Function Documentation

◆ getDescription()

ILIAS\ILIASObject\Properties\Translations\Language::getDescription ( )

Definition at line 63 of file Language.php.

                                    : string
    {
        return $this->description;
    }

Referenced by ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Normalizer\IlObjectNormalizer\normalizeTranslations().

Here is the caller graph for this function:

◆ getDisplayValueForKey()

ILIAS\ILIASObject\Properties\Translations\Language::getDisplayValueForKey	(	SystemLanguage	$lng,
		string	$key
	)

Definition at line 145 of file Language.php.

     : string|bool {
        return match($key) {
            self::KEY_LANGUAGE => $this->getTranslatedLanguageName(
                $lng,
                $this->language_code
            ),
            self::KEY_BASE => $this->base,
            self::KEY_DEFAULT => $this->default,
            self::KEY_TITLE => $this->title,
            self::KEY_DESCRIPTION => $this->description
        };
    }

References $lng.

◆ getLanguageCode()

ILIAS\ILIASObject\Properties\Translations\Language::getLanguageCode ( )

Definition at line 46 of file Language.php.

                                     : string
    {
        return $this->language_code;
    }

Referenced by ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Normalizer\IlObjectNormalizer\normalizeTranslations(), and ILIAS\ILIASObject\Properties\Translations\Translations\withLanguage().

Here is the caller graph for this function:

◆ getTitle()

ILIAS\ILIASObject\Properties\Translations\Language::getTitle ( )

Definition at line 51 of file Language.php.

                              : string
    {
        return $this->title;
    }

Referenced by ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Normalizer\IlObjectNormalizer\normalizeTranslations().

Here is the caller graph for this function:

◆ getTranslatedLanguageName()

ILIAS\ILIASObject\Properties\Translations\Language::getTranslatedLanguageName	(	SystemLanguage	$lng,
		string	$language_code
	)

private

Definition at line 161 of file Language.php.

     : string {
        return $lng->txt("meta_l_{$language_code}");
    }

◆ isBase()

ILIAS\ILIASObject\Properties\Translations\Language::isBase ( )

Definition at line 87 of file Language.php.

                            : bool
    {
        return $this->base;
    }

Referenced by ILIAS\ILIASObject\Properties\Translations\Translations\withLanguage().

Here is the caller graph for this function:

◆ isDefault()

ILIAS\ILIASObject\Properties\Translations\Language::isDefault ( )

Definition at line 75 of file Language.php.

                               : bool
    {
        return $this->default;
    }

Referenced by ILIAS\ILIASObject\Properties\Translations\Translations\withLanguage().

Here is the caller graph for this function:

◆ toForm()

ILIAS\ILIASObject\Properties\Translations\Language::toForm	(	\ilLanguage	$language,
		FieldFactory	$field_factory,
		Refinery	$refinery
	)

Definition at line 99 of file Language.php.

     : array {
        return [
            $field_factory->group([
                self::KEY_LANGUAGE => $field_factory->hidden()->withValue($this->language_code),
                self::KEY_TITLE => $field_factory->text($language->txt('title'))
                    ->withRequired(true)
                    ->withValue($this->title),
                self::KEY_DESCRIPTION => $field_factory->textarea($language->txt('description'))
                    ->withValue($this->description),
                self::KEY_DEFAULT => $field_factory->hidden()->withValue($this->isDefault()),
                self::KEY_BASE => $field_factory->hidden()->withValue($this->isBase()),
            ])->withAdditionalTransformation(
                $refinery->custom()->transformation(
                    static fn(array $vs): self => new self(
                        $vs[self::KEY_LANGUAGE],
                        $vs[self::KEY_TITLE],
                        $vs[self::KEY_DESCRIPTION],
                        $vs[self::KEY_DEFAULT] === '1',
                        $vs[self::KEY_BASE] === '1'
                    )
                )
            )
        ];
    }

◆ toRow()

ILIAS\ILIASObject\Properties\Translations\Language::toRow	(	DataRowBuilder	$row_builder,
		SystemLanguage	$lng
	)

Definition at line 128 of file Language.php.

     : DataRow {
        return $row_builder->buildDataRow(
            $this->language_code,
            [
                self::KEY_LANGUAGE => $this->getTranslatedLanguageName($lng, $this->language_code),
                self::KEY_BASE => $this->isBase(),
                self::KEY_DEFAULT => $this->isDefault(),
                self::KEY_TITLE => $this->getTitle(),
                self::KEY_DESCRIPTION => $this->getDescription()
            ]
        )->withDisabledAction(TranslationsTable::ACTION_DELETE, $this->isBase() || $this->isDefault())
        ->withDisabledAction(TranslationsTable::ACTION_MAKE_DEFAULT, $this->isDefault());
    }

◆ withBase()

ILIAS\ILIASObject\Properties\Translations\Language::withBase ( bool $base )

Definition at line 92 of file Language.php.

                                        : self
    {
        $clone = clone $this;
        $clone->base = $base;
        return $clone;
    }

Referenced by ILIAS\ILIASObject\Properties\Translations\Translations\withLanguage().

Here is the caller graph for this function:

◆ withDefault()

ILIAS\ILIASObject\Properties\Translations\Language::withDefault ( bool $default )

Definition at line 80 of file Language.php.

                                              : self
    {
        $clone = clone $this;
        $clone->default = $default;
        return $clone;
    }

◆ withDescription()

ILIAS\ILIASObject\Properties\Translations\Language::withDescription ( string $description )

Definition at line 68 of file Language.php.

                                                        : self
    {
        $clone = clone $this;
        $clone->description = $description;
        return $clone;
    }

◆ withTitle()

ILIAS\ILIASObject\Properties\Translations\Language::withTitle ( string $title )

Definition at line 56 of file Language.php.

                                            : self
    {
        $clone = clone $this;
        $clone->title = $title;
        return $clone;
    }

Field Documentation

◆ KEY_BASE

const ILIAS\ILIASObject\Properties\Translations\Language::KEY_BASE = 'base'

Definition at line 32 of file Language.php.

◆ KEY_DEFAULT

const ILIAS\ILIASObject\Properties\Translations\Language::KEY_DEFAULT = 'default'

Definition at line 33 of file Language.php.

◆ KEY_DESCRIPTION

const ILIAS\ILIASObject\Properties\Translations\Language::KEY_DESCRIPTION = 'description'

Definition at line 35 of file Language.php.

◆ KEY_LANGUAGE

const ILIAS\ILIASObject\Properties\Translations\Language::KEY_LANGUAGE = 'language'

Definition at line 31 of file Language.php.

◆ KEY_TITLE

const ILIAS\ILIASObject\Properties\Translations\Language::KEY_TITLE = 'title'

Definition at line 34 of file Language.php.

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

components/ILIAS/ILIASObject/src/Properties/Translations/Language.php

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDescription()

◆ getDisplayValueForKey()

◆ getLanguageCode()

◆ getTitle()

◆ getTranslatedLanguageName()

◆ isBase()

◆ isDefault()

◆ toForm()

◆ toRow()

◆ withBase()

◆ withDefault()

◆ withDescription()

◆ withTitle()

Field Documentation

◆ KEY_BASE

◆ KEY_DEFAULT

◆ KEY_DESCRIPTION

◆ KEY_LANGUAGE

◆ KEY_TITLE