ilPageMultiLang Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPageMultiLang:

Public Member Functions
	__construct (string $a_parent_type, int $a_parent_id)
	Constructor. More...
	setParentType (string $a_val)
	getParentType ()
	setParentId (int $a_val)
	getParentId ()
	setMasterLanguage (string $a_val)
	getMasterLanguage ()
	setLanguages (array $a_val)
	getLanguages ()
	addLanguage (string $a_lang)
	getActivated ()
	read ()
	delete ()
	save ()
	copy (string $a_target_parent_type, int $a_target_parent_id)
	Copy multilinguality settings. More...
	getEffectiveLang (string $a_lang)
	Get effective language for given language. More...

Protected Member Functions
	setActivated (bool $a_val)

Protected Attributes
ilDBInterface	$db
string	$parent_type
int	$parent_id
string	$master_lang
array	$languages = array()
bool	$activated = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Multi-language properties

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 24 of file class.ilPageMultiLang.php.

Constructor & Destructor Documentation

__construct()

ilPageMultiLang::__construct	(	string	$a_parent_type,
		int	$a_parent_id
	)

Constructor.

Parameters

string	$a_parent_type	parent object type
int	$a_parent_id	parent object id

Exceptions

ilCOPageException

Definition at line 40 of file class.ilPageMultiLang.php.

References $DIC, $ilDB, getParentId(), getParentType(), read(), setParentId(), and setParentType().

      {
        global $DIC;

        $ilDB = $DIC->database();

        $this->db = $ilDB;

        $this->setParentType($a_parent_type);
        $this->setParentId($a_parent_id);

        if ($this->getParentType() == "") {
            throw new ilCOPageException("ilPageMultiLang: No parent type passed.");
        }

        if ($this->getParentId() <= 0) {
            throw new ilCOPageException("ilPageMultiLang: No parent ID passed.");
        }

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

addLanguage()

ilPageMultiLang::addLanguage

(

string

$a_lang

)

Definition at line 104 of file class.ilPageMultiLang.php.

Referenced by read().

                                               : void
    {
        if ($a_lang != "" && !in_array($a_lang, $this->languages)) {
            $this->languages[] = $a_lang;
        }
    }

Here is the caller graph for this function:

copy()

ilPageMultiLang::copy	(	string	$a_target_parent_type,
		int	$a_target_parent_id
	)

Copy multilinguality settings.

Parameters

string	$a_target_parent_type	parent object type
int	$a_target_parent_id	parent object id

Returns

?ilPageMultiLang target multilang object

Exceptions

ilCOPageException

Definition at line 189 of file class.ilPageMultiLang.php.

References getActivated(), getLanguages(), getMasterLanguage(), and null.

     : ?ilPageMultiLang {
        if ($this->getActivated()) {
            $target_ml = new ilPageMultiLang($a_target_parent_type, $a_target_parent_id);
            $target_ml->setMasterLanguage($this->getMasterLanguage());
            $target_ml->setLanguages($this->getLanguages());
            $target_ml->save();
            return $target_ml;
        }

        return null;
    }

Here is the call graph for this function:

delete()

ilPageMultiLang::delete

(

)

Definition at line 146 of file class.ilPageMultiLang.php.

                            : void
    {
        $this->db->manipulate(
            "DELETE FROM copg_multilang " .
            " WHERE parent_type = " . $this->db->quote($this->getParentType(), "text") .
            " AND parent_id = " . $this->db->quote($this->getParentId(), "integer")
        );
        $this->db->manipulate(
            "DELETE FROM copg_multilang_lang " .
            " WHERE parent_type = " . $this->db->quote($this->getParentType(), "text") .
            " AND parent_id = " . $this->db->quote($this->getParentId(), "integer")
        );
    }

getActivated()

ilPageMultiLang::getActivated

(

)

Definition at line 116 of file class.ilPageMultiLang.php.

References $activated.

Referenced by copy(), and getEffectiveLang().

                                  : bool
    {
        return $this->activated;
    }

Here is the caller graph for this function:

getEffectiveLang()

ilPageMultiLang::getEffectiveLang

(

string

$a_lang

)

Get effective language for given language.

This checks if

• multilinguality is activated and
• the given language is part of the available translations If not a "-" is returned (master language).

Parameters

string

$a_lang

language

Returns

string effective language ("-" for master)

Definition at line 214 of file class.ilPageMultiLang.php.

References ilPageObject\_exists(), getActivated(), getLanguages(), getParentId(), and getParentType().

                                                    : string
    {
        if ($this->getActivated() &&
            in_array($a_lang, $this->getLanguages()) &&
            ilPageObject::_exists($this->getParentType(), $this->getParentId(), $a_lang)) {
            return $a_lang;
        }
        return "-";
    }

Here is the call graph for this function:

getLanguages()

ilPageMultiLang::getLanguages

(

)

Definition at line 99 of file class.ilPageMultiLang.php.

References $languages.

Referenced by copy(), getEffectiveLang(), and save().

                                  : array
    {
        return $this->languages;
    }

Here is the caller graph for this function:

getMasterLanguage()

ilPageMultiLang::getMasterLanguage

(

)

Definition at line 89 of file class.ilPageMultiLang.php.

References $master_lang.

Referenced by copy().

                                       : string
    {
        return $this->master_lang;
    }

Here is the caller graph for this function:

getParentId()

ilPageMultiLang::getParentId

(

)

Definition at line 79 of file class.ilPageMultiLang.php.

References $parent_id.

Referenced by __construct(), and getEffectiveLang().

                                 : int
    {
        return $this->parent_id;
    }

Here is the caller graph for this function:

getParentType()

ilPageMultiLang::getParentType

(

)

Definition at line 69 of file class.ilPageMultiLang.php.

References $parent_type.

Referenced by __construct(), and getEffectiveLang().

                                   : string
    {
        return $this->parent_type;
    }

Here is the caller graph for this function:

read()

ilPageMultiLang::read

(

)

Definition at line 121 of file class.ilPageMultiLang.php.

References addLanguage(), setActivated(), setLanguages(), and setMasterLanguage().

Referenced by __construct().

                          : void
    {
        $set = $this->db->query(
            "SELECT * FROM copg_multilang " .
            " WHERE parent_type = " . $this->db->quote($this->getParentType(), "text") .
            " AND parent_id = " . $this->db->quote($this->getParentId(), "integer")
        );
        if ($rec = $this->db->fetchAssoc($set)) {
            $this->setMasterLanguage($rec["master_lang"]);
            $this->setActivated(true);
        } else {
            $this->setActivated(false);
        }

        $this->setLanguages(array());
        $set = $this->db->query(
            "SELECT * FROM copg_multilang_lang " .
            " WHERE parent_type = " . $this->db->quote($this->getParentType(), "text") .
            " AND parent_id = " . $this->db->quote($this->getParentId(), "integer")
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            $this->addLanguage($rec["lang"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilPageMultiLang::save

(

)

Definition at line 160 of file class.ilPageMultiLang.php.

References $lang, and getLanguages().

                          : void
    {
        $this->delete();

        $this->db->manipulate("INSERT INTO copg_multilang " .
            "(parent_type, parent_id, master_lang) VALUES (" .
            $this->db->quote($this->getParentType(), "text") . "," .
            $this->db->quote($this->getParentId(), "integer") . "," .
            $this->db->quote($this->getMasterLanguage(), "text") .
            ")");

        foreach ($this->getLanguages() as $lang) {
            $this->db->manipulate("INSERT INTO copg_multilang_lang " .
                "(parent_type, parent_id, lang) VALUES (" .
                $this->db->quote($this->getParentType(), "text") . "," .
                $this->db->quote($this->getParentId(), "integer") . "," .
                $this->db->quote($lang, "text") .
                ")");
        }
    }

Here is the call graph for this function:

setActivated()

ilPageMultiLang::setActivated ( bool  $a_val )

protected

Definition at line 111 of file class.ilPageMultiLang.php.

Referenced by read().

                                                : void
    {
        $this->activated = $a_val;
    }

Here is the caller graph for this function:

setLanguages()

ilPageMultiLang::setLanguages

(

array

$a_val

)

Definition at line 94 of file class.ilPageMultiLang.php.

Referenced by read().

                                              : void
    {
        $this->languages = $a_val;
    }

Here is the caller graph for this function:

setMasterLanguage()

ilPageMultiLang::setMasterLanguage

(

string

$a_val

)

Definition at line 84 of file class.ilPageMultiLang.php.

Referenced by read().

                                                    : void
    {
        $this->master_lang = $a_val;
    }

Here is the caller graph for this function:

setParentId()

ilPageMultiLang::setParentId

(

int

$a_val

)

Definition at line 74 of file class.ilPageMultiLang.php.

Referenced by __construct().

                                           : void
    {
        $this->parent_id = $a_val;
    }

Here is the caller graph for this function:

setParentType()

ilPageMultiLang::setParentType

(

string

$a_val

)

Definition at line 64 of file class.ilPageMultiLang.php.

Referenced by __construct().

                                                : void
    {
        $this->parent_type = $a_val;
    }

Here is the caller graph for this function:

Field Documentation

$activated

bool ilPageMultiLang::$activated = false

protected

Definition at line 31 of file class.ilPageMultiLang.php.

Referenced by getActivated().

$db

ilDBInterface ilPageMultiLang::$db

protected

Definition at line 26 of file class.ilPageMultiLang.php.

$languages

array ilPageMultiLang::$languages = array()

protected

Definition at line 30 of file class.ilPageMultiLang.php.

Referenced by getLanguages().

$master_lang

string ilPageMultiLang::$master_lang

protected

Definition at line 29 of file class.ilPageMultiLang.php.

Referenced by getMasterLanguage().

$parent_id

int ilPageMultiLang::$parent_id

protected

Definition at line 28 of file class.ilPageMultiLang.php.

Referenced by getParentId().

$parent_type

string ilPageMultiLang::$parent_type

protected

Definition at line 27 of file class.ilPageMultiLang.php.

Referenced by getParentType().

---

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

• components/ILIAS/COPage/classes/class.ilPageMultiLang.php