class.ilObjectTranslation.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2014 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilObjectTranslation
{
    protected $db;
    protected $obj_id;
    protected $master_lang;
    protected $languages = array();
    protected $content_activated = false;
    protected static $instances = array();
    protected $fallback_language = "";

    private function __construct($a_obj_id)
    {
        global $DIC;

        $ilDB = $DIC->database();

        $this->db = $ilDB;

        $this->setObjId($a_obj_id);

        if ($this->getObjId() <= 0) {
            include_once("./Services/Object/exceptions/class.ilObjectException.php");
            throw new ilObjectException("ilObjectTranslation: No object ID passed.");
        }

        $this->read();
    }

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

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


    public function setObjId($a_val)
    {
        $this->obj_id = $a_val;
    }

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

    public function setMasterLanguage($a_val)
    {
        $this->master_lang = $a_val;
    }

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

    public function setLanguages(array $a_val)
    {
        $this->languages = $a_val;
    }

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

    public function setFallbackLanguage($a_val)
    {
        $this->fallback_language = $a_val;
    }

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

    public function addLanguage($a_lang, $a_title, $a_description, $a_default, $a_force = false)
    {
        if ($a_lang != "" && (!isset($this->languages[$a_lang]) || $a_force)) {
            if ($a_default) {
                foreach ($this->languages as $k => $l) {
                    $this->languages[$k]["lang_default"] = false;
                }
            }
            $this->languages[$a_lang] = array("lang_code" => $a_lang, "lang_default" => $a_default,
                "title" => $a_title, "description" => $a_description);
        }
    }

    public function getDefaultTitle()
    {
        if ($this->getFallbackLanguage() != "") {
            return $this->languages[$this->getFallbackLanguage()]["title"];
        } else {
            foreach ($this->languages as $l) {
                if ($l["lang_default"]) {
                    return $l["title"];
                }
            }
        }
        if (count($this->languages) == 0) {
            return ilObject::_lookupTitle($this->getObjId());
        }
        return "";
    }

    public function setDefaultTitle($a_title)
    {
        if ($this->getFallbackLanguage() != "") {
            $this->languages[$this->getFallbackLanguage()]["title"] = $a_title;
        } else {
            foreach ($this->languages as $k => $l) {
                if ($l["lang_default"]) {
                    $this->languages[$k]["title"] = $a_title;
                }
            }
        }
    }

    public function getDefaultDescription()
    {
        if ($this->getFallbackLanguage() != "") {
            return $this->languages[$this->getFallbackLanguage()]["description"];
        }
        foreach ($this->languages as $l) {
            if ($l["lang_default"]) {
                return $l["description"];
            }
        }
        if (count($this->languages) == 0) {
            return ilObject::_lookupDescription($this->getObjId());
        }
        return "";
    }

    public function setDefaultDescription($a_description)
    {
        if ($this->getFallbackLanguage() != "") {
            $this->languages[$this->getFallbackLanguage()]["description"] = $a_description;
        } else {
            foreach ($this->languages as $k => $l) {
                if ($l["lang_default"]) {
                    $this->languages[$k]["description"] = $a_description;
                }
            }
        }
    }

    public function getDefaultLanguage()
    {
        if ($this->getFallbackLanguage() != "") {
            return $this->getFallbackLanguage();
        }
        foreach ($this->languages as $l) {
            if ($l["lang_default"]) {
                return $l["lang_code"];
            }
        }
        return "";
    }


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


    protected function setContentActivated($a_val)
    {
        $this->content_activated = $a_val;
    }

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

    public function read()
    {
        $set = $this->db->query(
            "SELECT * FROM obj_content_master_lng " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
        if ($rec = $this->db->fetchAssoc($set)) {
            $this->setMasterLanguage($rec["master_lang"]);
            $this->setFallbackLanguage($rec["fallback_lang"]);
            $this->setContentActivated(true);
        } else {
            $this->setContentActivated(false);
        }

        $this->setLanguages(array());
        $set = $this->db->query(
            "SELECT * FROM object_translation " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            $this->addLanguage($rec["lang_code"], $rec["title"], $rec["description"], $rec["lang_default"]);
        }
    }

    public function delete()
    {
        $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()
    {
        $this->db->manipulate(
            "DELETE FROM obj_content_master_lng " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
    }

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

        if ($this->getMasterLanguage() != "") {
            $this->db->manipulate("INSERT INTO obj_content_master_lng " .
                "(obj_id, master_lang, fallback_lang) VALUES (" .
                $this->db->quote($this->getObjId(), "integer") . "," .
                $this->db->quote($this->getMasterLanguage(), "text") . "," .
                $this->db->quote($this->getFallbackLanguage(), "text") .
                ")");
            // ensure that an entry for the master language exists and is the default
            if (!isset($this->languages[$this->getMasterLanguage()])) {
                $this->languages[$this->getMasterLanguage()] = array("title" => "",
                    "description" => "", "lang_code" => $this->getMasterLanguage(), "lang_default" => 1);
            }
            foreach ($this->languages as $l => $trans) {
                if ($l == $this->getMasterLanguage()) {
                    $this->languages[$l]["lang_default"] = 1;
                } else {
                    $this->languages[$l]["lang_default"] = 0;
                }
            }
        }
        foreach ($this->getLanguages() as $l => $trans) {
            $this->db->manipulate($t = "INSERT INTO object_translation " .
                "(obj_id, title, description, lang_code, lang_default) VALUES (" .
                $this->db->quote($this->getObjId(), "integer") . "," .
                $this->db->quote($trans["title"], "text") . "," .
                $this->db->quote($trans["description"], "text") . "," .
                $this->db->quote($l, "text") . "," .
                $this->db->quote($trans["lang_default"], "integer") .
                ")");
        }
    }

    public function copy($a_obj_id)
    {
        $target_ml = new ilObjectTranslation($a_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($a_lang, $a_parent_type)
    {
        $langs = $this->getLanguages();
        $page_lang_key = ($a_lang == $this->getMasterLanguage())
            ? "-"
            : $a_lang;
        if ($this->getContentActivated() &&
            isset($langs[$a_lang]) &&
            ilPageObject::_exists($a_parent_type, $this->getObjId(), $page_lang_key)) {
            if ($a_lang == $this->getMasterLanguage()) {
                return "-";
            }
            return $a_lang;
        }
        if ($this->getContentActivated() &&
            isset($langs[$this->getFallbackLanguage()]) &&
            ilPageObject::_exists($a_parent_type, $this->getObjId(), $this->getFallbackLanguage())) {
            return $this->getFallbackLanguage();
        }
        return "-";
    }
}