Class ilOrgUnitTypeTranslation This class represents a translation for a given ilOrgUnit object and language. More...

Collaboration diagram for ilOrgUnitTypeTranslation:

Public Member Functions
	__construct ($a_org_type_id=0, $a_lang_code='')

	getMember ($a_member)
	Get translated value for a member, returns null if no translation exists. More...

	setMember ($a_member, $a_value)
	Set translation value for a member, either update or add value. More...

	create ()
	Insert all translated member into database. More...

	update ()
	Update translations in database. More...

	delete ()
	Delete object. More...

	setLang ($lang)
	Getters & Setters. More...

	getLang ()

	getMembers ()

	getOrguTypeId ()

	setOrguTypeId ($id)

Static Public Member Functions
static	getInstance ($a_orgu_type_id, $a_lang_code)
	Public. More...

Data Fields
const	TABLE_NAME = 'orgu_types_trans'

Protected Member Functions
	insertMember ($member, $value)
	Protected. More...

	updateMember ($member, $value)
	Update a (member,value) pair in database. More...

	trackChange ($a_member, $is_new)
	Track a member that was either updated or added. More...

	resetTrackChanges ()
	Reset tracked members. More...

	read ()
	Read object data from database. More...

Protected Attributes
	$orgu_type_id

	$lang = ''

	$members = array()

	$changes = array()

	$members_new = array()

	$db

	$log

Static Protected Attributes
static	$instances = array()

Detailed Description

Class ilOrgUnitTypeTranslation This class represents a translation for a given ilOrgUnit object and language.

Author: : Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 9 of file class.ilOrgUnitTypeTranslation.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitTypeTranslation::__construct	(	$a_org_type_id = `0`,
		$a_lang_code = `''`
	)

Definition at line 46 of file class.ilOrgUnitTypeTranslation.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilLog = $DIC['ilLog'];
        $this->db = $ilDB;
        $this->log = $ilLog;
        if ($a_org_type_id && $a_lang_code) {
            $this->orgu_type_id = (int) $a_org_type_id;
            $this->lang = $a_lang_code;
            $this->read();
        }
    }

References $DIC, $ilDB, and read().

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilOrgUnitTypeTranslation::create ( )

Insert all translated member into database.

Definition at line 178 of file class.ilOrgUnitTypeTranslation.php.

    {
        foreach ($this->members as $member => $value) {
            $this->insertMember($member, $value);
        }
        $this->resetTrackChanges();
    }

References insertMember(), and resetTrackChanges().

Here is the call graph for this function:

◆ delete()

ilOrgUnitTypeTranslation::delete ( )

Delete object.

Definition at line 207 of file class.ilOrgUnitTypeTranslation.php.

    {
        $sql = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE orgu_type_id = ' . $this->db->quote($this->getOrguTypeId(), 'integer') .
            ' AND lang = ' . $this->db->quote($this->getLang(), 'text');
        $this->db->manipulate($sql);
    }

References getOrguTypeId().

Here is the call graph for this function:

◆ getInstance()

static ilOrgUnitTypeTranslation::getInstance	(	$a_orgu_type_id,
		$a_lang_code
	)

static

Public.

Get instance of an ilOrgUnitType object Returns object from cache or from database, returns null if no object was found

Parameters

int	$a_orgu_type_id	ID of an ilOrgUnitType object
string	$a_lang_code	Language code

Returns: ilOrgUnitTypeTranslation|null

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

    {
        if (!$a_orgu_type_id || !$a_lang_code) {
            return null;
        }
        $cache_id = $a_orgu_type_id . $a_lang_code;
        if (isset(self::$instances[$cache_id])) {
            return self::$instances[$cache_id];
        } else {
            try {
                $trans = new self($a_orgu_type_id, $a_lang_code);
                self::$instances[$cache_id] = $trans;
 
                return $trans;
            } catch (ilOrgUnitTypeException $e) {
                return null;
            }
        }
    }

References Vendor\Package\$e.

Referenced by ilOrgUnitType\loadTranslation().

Here is the caller graph for this function:

◆ getLang()

ilOrgUnitTypeTranslation::getLang ( )

Returns: string

Definition at line 331 of file class.ilOrgUnitTypeTranslation.php.

    {
        return $this->lang;
    }

References $lang.

Referenced by insertMember(), and updateMember().

Here is the caller graph for this function:

◆ getMember()

ilOrgUnitTypeTranslation::getMember ( $a_member )

Get translated value for a member, returns null if no translation exists.

Parameters

string $a_member Name of the variable, e.g. title,description

Returns: string|null

Definition at line 155 of file class.ilOrgUnitTypeTranslation.php.

    {
        return (isset($this->members[$a_member])) ? (string) $this->members[$a_member] : null;
    }

Referenced by update().

Here is the caller graph for this function:

◆ getMembers()

ilOrgUnitTypeTranslation::getMembers ( )

Returns: array

Definition at line 340 of file class.ilOrgUnitTypeTranslation.php.

    {
        return $this->members;
    }

References $members.

◆ getOrguTypeId()

ilOrgUnitTypeTranslation::getOrguTypeId ( )

Returns: int

Definition at line 349 of file class.ilOrgUnitTypeTranslation.php.

    {
        return $this->orgu_type_id;
    }

References $orgu_type_id.

Referenced by delete(), insertMember(), and updateMember().

Here is the caller graph for this function:

◆ insertMember()

ilOrgUnitTypeTranslation::insertMember	(	$member,
		$value
	)

protected

Protected.

Insert a (member,value) pair in database

Parameters

$member
$value

Definition at line 240 of file class.ilOrgUnitTypeTranslation.php.

    {
        $this->db->insert(self::TABLE_NAME, array(
            'orgu_type_id' => array('integer', $this->getOrguTypeId()),
            'lang' => array('text', $this->getLang()),
            'member' => array('text', $member),
            'value' => array('text', $value),
        ));
    }

References getLang(), and getOrguTypeId().

Referenced by create(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilOrgUnitTypeTranslation::read ( )

protected

Read object data from database.

Exceptions

ilOrgUnitTypeException

Definition at line 301 of file class.ilOrgUnitTypeTranslation.php.

    {
        $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_type_id = ' . $this->db->quote($this->orgu_type_id, 'integer') .
            ' AND lang = ' . $this->db->quote($this->lang, 'text');
        $set = $this->db->query($sql);
        if (!$this->db->numRows($set)) {
            throw new ilOrgUnitTypeException("OrgUnit type translation for OrgUnit type {$this->orgu_type_id} and language {$this->lang} does not exist in database");
        }
        while ($rec = $this->db->fetchObject($set)) {
            $this->members[$rec->member] = (string) $rec->value;
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ resetTrackChanges()

ilOrgUnitTypeTranslation::resetTrackChanges ( )

protected

Reset tracked members.

Definition at line 289 of file class.ilOrgUnitTypeTranslation.php.

    {
        $this->changes = array();
        $this->members_new = array();
    }

Referenced by create(), and update().

Here is the caller graph for this function:

◆ setLang()

ilOrgUnitTypeTranslation::setLang ( $lang )

Getters & Setters.

Parameters

string $lang

Definition at line 322 of file class.ilOrgUnitTypeTranslation.php.

    {
        $this->lang = $lang;
    }

References $lang.

◆ setMember()

ilOrgUnitTypeTranslation::setMember	(	$a_member,
		$a_value
	)

Set translation value for a member, either update or add value.

Parameters

string	$a_member	Name of the variable, e.g. title,description
string	$a_value	Value of the translation

Definition at line 167 of file class.ilOrgUnitTypeTranslation.php.

    {
        $is_new = !isset($this->members[$a_member]);
        $this->members[$a_member] = (string) $a_value;
        $this->trackChange($a_member, $is_new);
    }

References trackChange().

Here is the call graph for this function:

◆ setOrguTypeId()

ilOrgUnitTypeTranslation::setOrguTypeId ( $id )

Parameters

int $id

Definition at line 358 of file class.ilOrgUnitTypeTranslation.php.

    {
        $this->orgu_type_id = (int) $id;
    }

◆ trackChange()

ilOrgUnitTypeTranslation::trackChange	(	$a_member,
		$is_new
	)

protected

Track a member that was either updated or added.

Parameters

string	$a_member	Name of a variable, e.g. title,description
bool	$is_new	True if the member did not exist before

Definition at line 275 of file class.ilOrgUnitTypeTranslation.php.

    {
        if (!in_array($a_member, $this->changes)) {
            $this->changes[] = $a_member;
        }
        if ($is_new && !in_array($a_member, $this->members_new)) {
            $this->members_new[] = $a_member;
        }
    }

Referenced by setMember().

Here is the caller graph for this function:

◆ update()

ilOrgUnitTypeTranslation::update ( )

Update translations in database.

Newly added members are inserted.

Definition at line 190 of file class.ilOrgUnitTypeTranslation.php.

    {
        foreach ($this->changes as $changed_member) {
            // Check if the member needs to be updated or inserted into database
            if (in_array($changed_member, $this->members_new)) {
                $this->insertMember($changed_member, $this->getMember($changed_member));
            } else {
                $this->updateMember($changed_member, $this->getMember($changed_member));
            }
        }
        $this->resetTrackChanges();
    }

References getMember(), insertMember(), resetTrackChanges(), and updateMember().

Here is the call graph for this function:

◆ updateMember()

ilOrgUnitTypeTranslation::updateMember	(	$member,
		$value
	)

protected

Update a (member,value) pair in database.

Parameters

$member
$value

Definition at line 257 of file class.ilOrgUnitTypeTranslation.php.

    {
        $this->db->update(self::TABLE_NAME, array(
            'value' => array('text', $value),
        ), array(
            'orgu_type_id' => array('integer', $this->getOrguTypeId()),
            'lang' => array('text', $this->getLang()),
            'member' => array('text', $member),
        ));
    }