ilPageMultiLang Class Reference

Multi-language properties. More...

Collaboration diagram for ilPageMultiLang:

Public Member Functions
	__construct ($a_parent_type, $a_parent_id)
	Constructor. More...
	setParentType ($a_val)
	Set parent type. More...
	getParentType ()
	Get parent type. More...
	setParentId ($a_val)
	Set parent id. More...
	getParentId ()
	Get parent id. More...
	setMasterLanguage ($a_val)
	Set master language. More...
	getMasterLanguage ()
	Get master language. More...
	setLanguages (array $a_val)
	Set languages. More...
	getLanguages ()
	Get languages. More...
	addLanguage ($a_lang)
	Add language. More...
	getActivated ()
	Get activated. More...
	read ()
	Read. More...
	delete ()
	Delete. More...
	save ()
	Save. More...
	copy ($a_target_parent_type, $a_target_parent_id)
	Copy multilinguality settings. More...
	getEffectiveLang ($a_lang)
	Get effective language for given language. More...

Protected Member Functions
	setActivated ($a_val)
	Set activated. More...

Protected Attributes
	$db
	$parent_type
	$parent_id
	$master_lang
	$languages = array()
	$activated = false

Detailed Description

Multi-language properties.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilPageMultiLang::__construct	(		$a_parent_type,
			$a_parent_id
	)

Constructor.

Parameters

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

Exceptions

ilCOPageException

Definition at line 28 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() == "") {
            include_once("./Services/COPage/exceptions/class.ilCOPageException.php");
            throw new ilCOPageException("ilPageMultiLang: No parent type passed.");
        }
        
        if ($this->getParentId() <= 0) {
            include_once("./Services/COPage/exceptions/class.ilCOPageException.php");
            throw new ilCOPageException("ilPageMultiLang: No parent ID passed.");
        }
        
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

addLanguage()

ilPageMultiLang::addLanguage

(

$a_lang

)

Add language.

Parameters

string

$a_lang

language

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

Referenced by read().

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

Here is the caller graph for this function:

copy()

ilPageMultiLang::copy	(		$a_target_parent_type,
			$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

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

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

    {
        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

(

)

Delete.

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

    {
        $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

(

)

Get activated.

Returns

bool activated?

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

References $activated.

Referenced by copy(), and getEffectiveLang().

    {
        return $this->activated;
    }

Here is the caller graph for this function:

getEffectiveLang()

ilPageMultiLang::getEffectiveLang

(

$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 264 of file class.ilPageMultiLang.php.

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

    {
        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

(

)

Get languages.

Returns

array array of language codes

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

References $languages.

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

    {
        return $this->languages;
    }

Here is the caller graph for this function:

getMasterLanguage()

ilPageMultiLang::getMasterLanguage

(

)

Get master language.

Returns

string master language

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

References $master_lang.

Referenced by copy().

    {
        return $this->master_lang;
    }

Here is the caller graph for this function:

getParentId()

ilPageMultiLang::getParentId

(

)

Get parent id.

Returns

int parent id

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

References $parent_id.

Referenced by __construct(), and getEffectiveLang().

    {
        return $this->parent_id;
    }

Here is the caller graph for this function:

getParentType()

ilPageMultiLang::getParentType

(

)

Get parent type.

Returns

string parent type

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

References $parent_type.

Referenced by __construct(), and getEffectiveLang().

    {
        return $this->parent_type;
    }

Here is the caller graph for this function:

read()

ilPageMultiLang::read

(

)

Read.

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

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

Referenced by __construct().

    {
        $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

(

)

Save.

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

References $lang, and getLanguages().

    {
        $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 (   $a_val )

protected

Set activated.

Parameters

bool

$a_val

activated?

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

Referenced by read().

    {
        $this->activated = $a_val;
    }

Here is the caller graph for this function:

setLanguages()

ilPageMultiLang::setLanguages

(

array

$a_val

)

Set languages.

Parameters

array

$a_val

array of language codes

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

Referenced by read().

    {
        $this->languages = $a_val;
    }

Here is the caller graph for this function:

setMasterLanguage()

ilPageMultiLang::setMasterLanguage

(

$a_val

)

Set master language.

Parameters

string

$a_val

master language

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

Referenced by read().

    {
        $this->master_lang = $a_val;
    }

Here is the caller graph for this function:

setParentId()

ilPageMultiLang::setParentId

(

$a_val

)

Set parent id.

Parameters

int

$a_val

parent id

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

Referenced by __construct().

    {
        $this->parent_id = $a_val;
    }

Here is the caller graph for this function:

setParentType()

ilPageMultiLang::setParentType

(

$a_val

)

Set parent type.

Parameters

string

$a_val

parent type

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

Referenced by __construct().

    {
        $this->parent_type = $a_val;
    }

Here is the caller graph for this function:

Field Documentation

$activated

ilPageMultiLang::$activated = false

protected

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

Referenced by getActivated().

$db

ilPageMultiLang::$db

protected

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

$languages

ilPageMultiLang::$languages = array()

protected

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

Referenced by getLanguages().

$master_lang

ilPageMultiLang::$master_lang

protected

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

Referenced by getMasterLanguage().

$parent_id

ilPageMultiLang::$parent_id

protected

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

Referenced by getParentId().

$parent_type

ilPageMultiLang::$parent_type

protected

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

Referenced by getParentType().

---

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

• Services/COPage/classes/class.ilPageMultiLang.php