ilOrgUnitTypeTranslation 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 ilOrgUnitTypeTranslation:

Public Member Functions
	__construct (int $a_org_type_id=0, string $a_lang_code='')
	getMember (string $a_member)
	Get translated value for a member, returns null if no translation exists. More...
	setMember (string $a_member, string $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 (string $lang)
	Getters & Setters. More...
	getLang ()
	getMembers ()
	getOrguTypeId ()
	setOrguTypeId (int $id)

Static Public Member Functions
static	getInstance (int $a_orgu_type_id, string $a_lang_code)
	Get instance of an ilOrgUnitType object Returns object from cache or from database, returns null if no object was found. More...

Data Fields
const	TABLE_NAME = 'orgu_types_trans'

Protected Member Functions
	insertMember (string $member, string $value)
	Protected. More...
	updateMember (string $member, string $value)
	Update a (member,value) pair in database. More...
	trackChange (string $a_member, bool $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
int	$orgu_type_id
string	$lang = ''
array	$members = []
array	$changes = []
array	$members_new = []
ilDBInterface	$db
ILIAS DI LoggingServices	$log

Static Protected Attributes
static array	$instances = []

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 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 25 of file class.ilOrgUnitTypeTranslation.php.

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\Repository\int(), and read().

    {
        global $DIC;
        $this->db = $DIC->database();
        $this->log = $DIC->logger();
        if ($a_org_type_id && $a_lang_code) {
            $this->orgu_type_id = (int) $a_org_type_id;
            $this->lang = $a_lang_code;
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilOrgUnitTypeTranslation::create

(

)

Insert all translated member into database.

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

References insertMember(), and resetTrackChanges().

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

Here is the call graph for this function:

delete()

ilOrgUnitTypeTranslation::delete

(

)

Delete object.

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

References $DIC, $ilDB, getLang(), and getOrguTypeId().

                            : void
    {
        $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);
    }

Here is the call graph for this function:

getInstance()

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

static

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 58 of file class.ilOrgUnitTypeTranslation.php.

References $DIC, Vendor\Package\$e, ilDBInterface\fetchObject(), ilDBInterface\numRows(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilOrgUnitType\loadTranslation().

                                                                                : ?ilOrgUnitTypeTranslation
    {
        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;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLang()

ilOrgUnitTypeTranslation::getLang

(

)

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

References $lang.

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

                             : string
    {
        return $this->lang;
    }

Here is the caller graph for this function:

getMember()

ilOrgUnitTypeTranslation::getMember

(

string

$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 135 of file class.ilOrgUnitTypeTranslation.php.

Referenced by update().

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

Here is the caller graph for this function:

getMembers()

ilOrgUnitTypeTranslation::getMembers

(

)

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

References $members.

                                : array
    {
        return $this->members;
    }

getOrguTypeId()

ilOrgUnitTypeTranslation::getOrguTypeId

(

)

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

References $orgu_type_id.

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

                                   : int
    {
        return $this->orgu_type_id;
    }

Here is the caller graph for this function:

insertMember()

ilOrgUnitTypeTranslation::insertMember ( string  $member, string  $value  )

protected

Protected.

Insert a (member,value) pair in database

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

References getLang(), and getOrguTypeId().

Referenced by create(), and update().

                                                                  : void
    {
        $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),
        ));
    }

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

Referenced by __construct().

                             : void
    {
        $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;
        }
    }

Here is the caller graph for this function:

resetTrackChanges()

ilOrgUnitTypeTranslation::resetTrackChanges ( )

protected

Reset tracked members.

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

Referenced by create(), and update().

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

Here is the caller graph for this function:

setLang()

ilOrgUnitTypeTranslation::setLang

(

string

$lang

)

Getters & Setters.

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

References $lang.

                                         : void
    {
        $this->lang = $lang;
    }

setMember()

ilOrgUnitTypeTranslation::setMember	(	string	$a_member,
		string	$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 145 of file class.ilOrgUnitTypeTranslation.php.

References trackChange().

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

Here is the call graph for this function:

setOrguTypeId()

ilOrgUnitTypeTranslation::setOrguTypeId

(

int

$id

)

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

References $id.

                                          : void
    {
        $this->orgu_type_id = $id;
    }

trackChange()

ilOrgUnitTypeTranslation::trackChange ( string  $a_member, bool  $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 241 of file class.ilOrgUnitTypeTranslation.php.

Referenced by setMember().

                                                                  : void
    {
        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;
        }
    }

Here is the caller graph for this function:

update()

ilOrgUnitTypeTranslation::update

(

)

Update translations in database.

Newly added members are inserted.

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

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

                            : void
    {
        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();
    }

Here is the call graph for this function:

updateMember()

ilOrgUnitTypeTranslation::updateMember ( string  $member, string  $value  )

protected

Update a (member,value) pair in database.

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

References getLang(), and getOrguTypeId().

Referenced by update().

                                                                  : void
    {
        $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),
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$changes

array ilOrgUnitTypeTranslation::$changes = []

protected

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

$db

ilDBInterface ilOrgUnitTypeTranslation::$db

protected

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

$instances

array ilOrgUnitTypeTranslation::$instances = []

staticprotected

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

$lang

string ilOrgUnitTypeTranslation::$lang = ''

protected

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

Referenced by getLang(), and setLang().

$log

ILIAS DI LoggingServices ilOrgUnitTypeTranslation::$log

protected

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

$members

array ilOrgUnitTypeTranslation::$members = []

protected

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

Referenced by getMembers().

$members_new

array ilOrgUnitTypeTranslation::$members_new = []

protected

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

$orgu_type_id

int ilOrgUnitTypeTranslation::$orgu_type_id

protected

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

Referenced by getOrguTypeId().

TABLE_NAME

const ilOrgUnitTypeTranslation::TABLE_NAME = 'orgu_types_trans'

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

---

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

• components/ILIAS/OrgUnit/classes/Types/class.ilOrgUnitTypeTranslation.php