class.ilObjectTranslation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjectTranslation
{
    protected static array $instances = [];

    protected ilDBInterface $db;
    protected int $obj_id;

    protected string $master_lang = "";
    protected array $languages = [];
    protected bool $content_activated = false;
    protected string $fallback_language = "";

    private function __construct(int $obj_id)
    {
        global $DIC;
        $this->db = $DIC->database();

        $this->setObjId($obj_id);

        if ($obj_id <= 0) {
            throw new ilObjectException("ilObjectTranslation: No object ID passed.");
        }

        $this->read();
    }

    public static function getInstance(int $obj_id): ilObjectTranslation
    {
        if (!isset(self::$instances[$obj_id])) {
            self::$instances[$obj_id] = new ilObjectTranslation($obj_id);
        }

        return self::$instances[$obj_id];
    }

    public function setObjId(int $val): void
    {
        $this->obj_id = $val;
    }

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

    public function setMasterLanguage(string $val): void
    {
        $this->master_lang = $val;
    }

    public function getMasterLanguage(): string
    {
        return $this->master_lang;
    }

    public function setLanguages(array $val): void
    {
        $this->languages = $val;
    }

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

    public function setFallbackLanguage(string $val): void
    {
        $this->fallback_language = $val;
    }

    public function getFallbackLanguage(): string
    {
        return $this->fallback_language;
    }

    public function addLanguage(
        string $lang,
        string $title,
        string $description,
        bool $default,
        bool $force = false
    ): void {
        if ($lang !== "" && (!isset($this->languages[$lang]) || $force)) {
            if ($default) {
                foreach ($this->languages as $l) {
                    $l->setDefault(false);
                }
            }
            $this->languages[$lang] = new ilObjectTranslationLanguage(
                $lang,
                $title,
                $description,
                $default
            );
        }
    }

    public function getDefaultTitle(): string
    {
        if ($this->fallback_language !== ""
            && array_key_exists($this->fallback_language, $this->languages)) {
            return $this->languages[$this->fallback_language]->getTitle();
        } else {
            foreach ($this->languages as $l) {
                if ($l->isDefault()) {
                    return $l->getTitle();
                }
            }
        }
        if (count($this->languages) == 0) {
            return ilObject::_lookupTitle($this->getObjId());
        }
        return '';
    }

    public function setDefaultTitle(string $title): void
    {
        if ($this->getFallbackLanguage() !== ''
            && isset($this->languages[$this->getFallbackLanguage()])) {
            $this->languages[$this->getFallbackLanguage()]->setTitle($title);
            return;
        }

        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                $l->setTitle($title);
                return;
            }
        }
    }

    public function getDefaultDescription(): string
    {
        if ($this->getFallbackLanguage() !== ''
            && array_key_exists($this->fallback_language, $this->languages)) {
            return $this->languages[$this->getFallbackLanguage()]->getDescription();
        }
        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                return $l->getDescription();
            }
        }
        if (count($this->languages) == 0) {
            return ilObject::_lookupDescription($this->getObjId());
        }
        return '';
    }

    public function setDefaultDescription(string $description): void
    {
        if ($this->getFallbackLanguage() !== ''
            && isset($this->languages[$this->getFallbackLanguage()])) {
            $this->languages[$this->getFallbackLanguage()]
                ->setDescription($description);
            return;
        }

        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                $l->setDescription($description);
                return;
            }
        }
    }

    public function getDefaultLanguage(): string
    {
        if ($this->getFallbackLanguage() !== "") {
            return $this->getFallbackLanguage();
        }
        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                return $l->getLanguageCode();
            }
        }
        return "";
    }

    public function removeLanguage(string $lang): void
    {
        if ($lang != $this->getMasterLanguage()) {
            unset($this->languages[$lang]);
        }
    }

    protected function setContentActivated(bool $val): void
    {
        $this->content_activated = $val;
    }

    public function getContentActivated(): bool
    {
        return $this->content_activated;
    }

    public function read(): void
    {
        $sql =
            "SELECT obj_id, master_lang, fallback_lang" . PHP_EOL
            . "FROM obj_content_master_lng" . PHP_EOL
            . "WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer") . PHP_EOL
        ;
        $result = $this->db->query($sql);
        if ($row = $this->db->fetchAssoc($result)) {
            $this->setMasterLanguage($row["master_lang"]);
            $this->setFallbackLanguage($row["fallback_lang"] ?? '');
            $this->setContentActivated(true);
        } else {
            $this->setContentActivated(false);
        }

        $this->setLanguages([]);

        $sql =
            "SELECT title, description, lang_code, lang_default" . PHP_EOL
            . "FROM object_translation" . PHP_EOL
            . "WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer") . PHP_EOL
        ;
        $result = $this->db->query($sql);
        while ($row = $this->db->fetchAssoc($result)) {
            $this->addLanguage($row["lang_code"], (string) $row["title"], (string) $row["description"], (bool) $row["lang_default"]);
        }
    }

    public function delete(): void
    {
        $this->db->manipulate(
            "DELETE FROM obj_content_master_lng " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
        $this->db->manipulate(
            "DELETE FROM object_translation " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
    }

    public function deactivateContentTranslation(): void
    {
        $this->db->manipulate(
            "DELETE FROM obj_content_master_lng " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
    }

    public function save(): void
    {
        $this->delete();

        if ($this->getMasterLanguage() != "") {
            $values = [
                "obj_id" => ["integer", $this->getObjId()],
                "master_lang" => ["text", $this->getMasterLanguage()],
                "fallback_lang" => ["text", $this->getFallbackLanguage()]
            ];

            $this->db->insert("obj_content_master_lng", $values);
            // ensure that an entry for the master language exists and is the default
            if (!isset($this->languages[$this->getMasterLanguage()])) {
                $this->languages[$this->getMasterLanguage()] = new ilObjectTranslationLanguage(
                    "",
                    "",
                    $this->getMasterLanguage(),
                    true
                );
            }
            foreach ($this->languages as $trans) {
                if ($trans->getLanguageCode() === $this->getMasterLanguage()) {
                    $trans->setDefault(true);
                } else {
                    $trans->setDefault(false);
                }
            }
        }

        foreach ($this->getLanguages() as $trans) {
            $values = [
                "obj_id" => ["integer", $this->getObjId()],
                "title" => ["text", $trans->getTitle()],
                "description" => ["text", $trans->getDescription()],
                "lang_code" => ["text", $trans->getLanguageCode()],
                "lang_default" => ["integer", $trans->isDefault()],
            ];
            $this->db->insert("object_translation", $values);
        }
    }

    public function copy(int $obj_id): ilObjectTranslation
    {
        $target_ml = new ilObjectTranslation($obj_id);
        $target_ml->setMasterLanguage($this->getMasterLanguage());
        $target_ml->setFallbackLanguage($this->getFallbackLanguage());
        $target_ml->setLanguages($this->getLanguages());
        $target_ml->save();
        return $target_ml;
    }


    public function getEffectiveContentLang(string $lang, string $parent_type): string
    {
        $langs = $this->getLanguages();
        $page_lang_key = ($lang == $this->getMasterLanguage())
            ? "-"
            : $lang;
        if ($this->getContentActivated() &&
            isset($langs[$lang]) &&
            ilPageObject::_exists($parent_type, $this->getObjId(), $page_lang_key)) {
            if ($lang == $this->getMasterLanguage()) {
                return "-";
            }
            return $lang;
        }
        if ($this->getContentActivated() &&
            isset($langs[$this->getFallbackLanguage()]) &&
            ilPageObject::_exists($parent_type, $this->getObjId(), $this->getFallbackLanguage())) {
            return $this->getFallbackLanguage();
        }
        return "-";
    }
}