ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilOrgUnitTypeTranslation Class Reference

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

54 {
55 global $ilDB, $ilLog;
56 $this->db = $ilDB;
57 $this->log = $ilLog;
58 if ($a_org_type_id && $a_lang_code) {
59 $this->orgu_type_id = (int) $a_org_type_id;
60 $this->lang = $a_lang_code;
61 $this->read();
62 }
63 }
read()
Read object data from database.
global $ilDB

References $ilDB, $ilLog, 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 166 of file class.ilOrgUnitTypeTranslation.php.

166 {
167 foreach ($this->members as $member => $value) {
168 $this->insertMember($member, $value);
169 }
170 $this->resetTrackChanges();
171 }
insertMember($member, $value)
Protected.

References insertMember(), and resetTrackChanges().

+ Here is the call graph for this function:

◆ delete()

ilOrgUnitTypeTranslation::delete ( )

Delete object.

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

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

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_idID of an ilOrgUnitType object
string$a_lang_codeLanguage code
Returns
ilOrgUnitTypeTranslation|null

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

79 {
80 if (!$a_orgu_type_id || !$a_lang_code) {
81 return null;
82 }
83 $cache_id = $a_orgu_type_id . $a_lang_code;
84 if (isset(self::$instances[$cache_id])) {
85 return self::$instances[$cache_id];
86 } else {
87 try {
88 $trans = new self($a_orgu_type_id, $a_lang_code);
89 self::$instances[$cache_id] = $trans;
90 return $trans;
91 } catch (ilOrgUnitTypeException $e) {
92 return null;
93 }
94 }
95 }
Class ilOrgUnitTypeException.

Referenced by ilOrgUnitType\loadTranslation().

+ Here is the caller graph for this function:

◆ getLang()

ilOrgUnitTypeTranslation::getLang ( )
Returns
string

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

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_memberName of the variable, e.g. title,description
Returns
string|null

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

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

Referenced by update().

+ Here is the caller graph for this function:

◆ getMembers()

ilOrgUnitTypeTranslation::getMembers ( )
Returns
array

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

References $members.

◆ getOrguTypeId()

ilOrgUnitTypeTranslation::getOrguTypeId ( )
Returns
int

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

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

221 {
222 $this->db->insert(self::TABLE_NAME, array(
223 'orgu_type_id' => array('integer', $this->getOrguTypeId()),
224 'lang' => array('text', $this->getLang()),
225 'member' => array('text', $member),
226 'value' => array('text', $value),
227 ));
228 }

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

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

Referenced by __construct().

+ Here is the caller graph for this function:

◆ resetTrackChanges()

ilOrgUnitTypeTranslation::resetTrackChanges ( )
protected

Reset tracked members.

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

265 {
266 $this->changes = array();
267 $this->members_new = array();
268 }

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

297 {
298 $this->lang = $lang;
299 }

References $lang.

◆ setMember()

ilOrgUnitTypeTranslation::setMember (   $a_member,
  $a_value 
)

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

Parameters
string$a_memberName of the variable, e.g. title,description
string$a_valueValue of the translation

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

157 {
158 $is_new = !isset($this->members[$a_member]);
159 $this->members[$a_member] = (string) $a_value;
160 $this->trackChange($a_member, $is_new);
161 }
trackChange($a_member, $is_new)
Track a member that was either updated or added.

References trackChange().

+ Here is the call graph for this function:

◆ setOrguTypeId()

ilOrgUnitTypeTranslation::setOrguTypeId (   $id)
Parameters
int$id

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

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

◆ trackChange()

ilOrgUnitTypeTranslation::trackChange (   $a_member,
  $is_new 
)
protected

Track a member that was either updated or added.

Parameters
string$a_memberName of a variable, e.g. title,description
bool$is_newTrue if the member did not exist before

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

253 {
254 if (!in_array($a_member, $this->changes)) {
255 $this->changes[] = $a_member;
256 }
257 if ($is_new && !in_array($a_member, $this->members_new)) {
258 $this->members_new[] = $a_member;
259 }
260 }

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

176 {
177 foreach ($this->changes as $changed_member) {
178 // Check if the member needs to be updated or inserted into database
179 if (in_array($changed_member, $this->members_new)) {
180 $this->insertMember($changed_member, $this->getMember($changed_member));
181 } else {
182 $this->updateMember($changed_member, $this->getMember($changed_member));
183 }
184 }
185 $this->resetTrackChanges();
186 }
updateMember($member, $value)
Update a (member,value) pair in database.
getMember($a_member)
Get translated value for a member, returns null if no translation exists.

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

237 {
238 $this->db->update(self::TABLE_NAME, array(
239 'value' => array('text', $value),
240 ), array(
241 'orgu_type_id' => array('integer', $this->getOrguTypeId()),
242 'lang' => array('text', $this->getLang()),
243 'member' => array('text', $member),
244 ));
245 }

References getLang(), and getOrguTypeId().

Referenced by update().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $changes

ilOrgUnitTypeTranslation::$changes = array()
protected

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

◆ $db

ilOrgUnitTypeTranslation::$db
protected

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

◆ $instances

ilOrgUnitTypeTranslation::$instances = array()
staticprotected

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

◆ $lang

ilOrgUnitTypeTranslation::$lang = ''
protected

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

Referenced by getLang(), and setLang().

◆ $log

ilOrgUnitTypeTranslation::$log
protected

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

◆ $members

ilOrgUnitTypeTranslation::$members = array()
protected

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

Referenced by getMembers().

◆ $members_new

ilOrgUnitTypeTranslation::$members_new = array()
protected

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

◆ $orgu_type_id

ilOrgUnitTypeTranslation::$orgu_type_id
protected

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

Referenced by getOrguTypeId().

◆ TABLE_NAME

const ilOrgUnitTypeTranslation::TABLE_NAME = 'orgu_types_trans'

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


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