Translations.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ILIASObject\Properties\Translations;

use ILIAS\ILIASObject\Properties\Property;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
use ILIAS\UI\Component\Input\Container\Form\FormInput;
use ILIAS\Refinery\Factory as Refinery;

class Translations
{
    public function __construct(
        private readonly int $obj_id,
        private array $languages,
        private string $default_language,
        private ?string $base_language,
        private readonly bool $migration_missing = false
    ) {
    }

    public function migrationMissing(): bool
    {
        return $this->migration_missing;
    }
    public function getObjId(): int
    {
        return $this->obj_id;
    }

    public function getDefaultLanguage(): string
    {
        return $this->default_language;
    }

    public function withDefaultLanguage(string $default_language): self
    {
        $clone = clone $this;
        $clone->languages[$clone->default_language] = $clone->languages[$clone->default_language]->withDefault(false);
        $clone->languages[$default_language] = $clone->languages[$default_language]->withDefault(true);
        $clone->default_language = $default_language;
        return $clone;
    }

    public function getBaseLanguage(): string
    {
        return $this->base_language ?? '';
    }

    public function withBaseLanguage(string $base_language): self
    {
        $clone = clone $this;
        if ($clone->base_language !== null) {
            $clone->languages[$clone->base_language] = $clone->languages[$clone->base_language]->withBase(false);
        }
        $clone->languages[$base_language] = $clone->languages[$base_language]->withBase(true);
        $clone->base_language = $base_language;
        return $clone;
    }

    public function getLanguages(): array
    {
        return $this->languages;
    }

    public function getLaguageForCode(string $lang_code): ?Language
    {
        return $this->languages[$lang_code] ?? null;
    }

    public function withLanguage(Language $lang): self
    {
        $clone = $this;
        $clone->languages[$lang->getLanguageCode()] = $lang;
        if ($lang->isBase() && $this->base_language !== $lang->getLanguageCode()) {
            if ($this->base_language !== null) {
                $clone->languages[$clone->base_language] = $clone->languages[$clone->base_language]->withBase(false);
            }
            $clone->base_language = $lang->getLanguageCode();
        }

        if ($lang->isDefault() && $this->default_language !== $lang->getLanguageCode()) {
            if ($this->default_language !== '') {
                $clone->languages[$clone->default_language] = $this->languages[$clone->default_language]->withDefault(false);
            }
            $clone->default_language = $lang->getLanguageCode();
        }

        return $clone;
    }

    public function withoutLanguage(string $lang): self
    {
        if ($lang === $this->base_language) {
            return $this;
        }

        $clone = $this;
        unset($clone->languages[$lang]);
        return $clone;
    }

    public function withResetLanguages(): self
    {
        $clone = clone $this;
        $clone->languages = [];
        return $clone;
    }

    public function getDefaultTitle(): string
    {
        if ($this->default_language !== ''
            && array_key_exists($this->default_language, $this->languages)) {
            return $this->languages[$this->default_language]->getTitle();
        }

        if ($this->languages === []) {
            return \ilObject::_lookupTitle($this->getObjId());
        }
        return '';
    }

    public function withDefaultTitle(string $title): self
    {
        if ($this->default_language === ''
            || !isset($this->languages[$this->default_language])) {
            return $this;
        }

        $clone = clone $this;
        $clone->languages[$clone->default_language] = $clone->languages[$clone->default_language]->withTitle($title);
        return $clone;
    }

    public function getDefaultDescription(): string
    {
        if ($this->default_language !== ''
            && array_key_exists($this->default_language, $this->languages)) {
            return $this->languages[$this->default_language]->getDescription();
        }

        if ($this->languages === []) {
            return \ilObject::_lookupTitle($this->getObjId());
        }
        return '';
    }

    public function withDefaultDescription(string $description): self
    {
        if ($this->default_language === ''
            || !isset($this->languages[$this->default_language])) {
            return $this;
        }

        $clone = clone $this;
        $clone->languages[$clone->default_language] = $clone->languages[$clone->default_language]->withDescription($description);
        return $clone;
    }

    public function getContentTranslationActivated(): bool
    {
        return $this->base_language !== null;
    }

    public function withDeactivatedContentTranslation(): self
    {
        $clone = clone $this;
        $clone->languages[$clone->base_language] = $clone->languages[$this->base_language]->withBase(false);
        $clone->base_language = null;
        return $clone;
    }

    public function copy(int $obj_id): self
    {
        return new self(
            $obj_id,
            $this->languages,
            $this->default_language,
            $this->base_language
        );
    }

    public function getEffectiveCOPageLang(
        string $lang,
        string $parent_type
    ): string {
        if ($this->base_language === null) {
            return '-';
        }

        $page_lang_key = $lang === $this->base_language
            ? '-'
            : $lang;

        if (isset($this->languages[$lang])
            && \ilPageObject::_exists($parent_type, $this->getObjId(), $page_lang_key)) {
            return $page_lang_key;
        }

        if (isset($this->languages[$this->default_language])
            && \ilPageObject::_exists($parent_type, $this->getObjId(), $this->default_language)) {
            return $this->default_language;
        }
        return '-';
    }
}