ILIAS\ILIASObject\Properties\Translations\Language Class Reference

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)

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 31 of file Language.php.

      {
    }

Member Function Documentation

getDescription()

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

(

)

Definition at line 57 of file Language.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\Language\toRow().

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getLanguageCode()

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

(

)

Definition at line 40 of file Language.php.

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

                                     : string
    {
        return $this->language_code;
    }

Here is the caller graph for this function:

getTitle()

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

(

)

Definition at line 45 of file Language.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\Language\toRow().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getTranslatedLanguageName()

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

private

Definition at line 139 of file Language.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\Language\toRow().

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

Here is the caller graph for this function:

isBase()

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

(

)

Definition at line 81 of file Language.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\Language\toForm(), ILIAS\ILIASObject\Properties\Translations\Language\toRow(), and ILIAS\ILIASObject\Properties\Translations\Translations\withLanguage().

                            : bool
    {
        return $this->base;
    }

Here is the caller graph for this function:

isDefault()

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

(

)

Definition at line 69 of file Language.php.

Referenced by ILIAS\ILIASObject\Properties\Translations\Language\toForm(), ILIAS\ILIASObject\Properties\Translations\Language\toRow(), and ILIAS\ILIASObject\Properties\Translations\Translations\withLanguage().

                               : bool
    {
        return $this->default;
    }

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 93 of file Language.php.

References ILIAS\ILIASObject\Properties\Translations\Language\isBase(), ILIAS\ILIASObject\Properties\Translations\Language\isDefault(), ilLanguage\txt(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

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

Here is the call graph for this function:

toRow()

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

Definition at line 122 of file Language.php.

References ILIAS\ILIASObject\Properties\Translations\TranslationsTable\ACTION_DELETE, ILIAS\ILIASObject\Properties\Translations\TranslationsTable\ACTION_MAKE_DEFAULT, ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\ILIASObject\Properties\Translations\Language\getDescription(), ILIAS\ILIASObject\Properties\Translations\Language\getTitle(), ILIAS\ILIASObject\Properties\Translations\Language\getTranslatedLanguageName(), ILIAS\ILIASObject\Properties\Translations\Language\isBase(), and ILIAS\ILIASObject\Properties\Translations\Language\isDefault().

     : DataRow {
        return $row_builder->buildDataRow(
            $this->language_code,
            [
                'language' => $this->getTranslatedLanguageName($lng, $this->language_code),
                'base' => $this->isBase(),
                'default' => $this->isDefault(),
                'title' => $this->getTitle(),
                'description' => $this->getDescription()
            ]
        )->withDisabledAction(TranslationsTable::ACTION_DELETE, $this->isBase() || $this->isDefault())
        ->withDisabledAction(TranslationsTable::ACTION_MAKE_DEFAULT, $this->isDefault());
    }

Here is the call graph for this function:

withBase()

ILIAS\ILIASObject\Properties\Translations\Language::withBase

(

bool

$base

)

Definition at line 86 of file Language.php.

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

withDefault()

ILIAS\ILIASObject\Properties\Translations\Language::withDefault

(

bool

$default

)

Definition at line 74 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 62 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 50 of file Language.php.

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

---

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

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