Class ilMMItemTranslationStorage. More...

Inheritance diagram for ilMMItemTranslationStorage:

Collaboration diagram for ilMMItemTranslationStorage:

Public Member Functions
	getId ()

	setId (string $id)

	getIdentification ()

	setIdentification (string $identification)

	getTranslation ()

	setTranslation (string $translation)

	getLanguageKey ()

	setLanguageKey (string $language_key)

	getCache ()
	@inheritDoc More...

Public Member Functions inherited from CachedActiveRecord
	getCache ()

	getCacheIdentifier ()

	getTTL ()

	__construct ($primary_key=0, arConnector $connector=null)
	@inheritDoc More...

	afterObjectLoad ()

	create ()

	copy (int $new_id=0)
	@inheritDoc More...

	read ()

	update ()

	delete ()

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()
	@description Return the Name of your Connector Table More...

	setConnectorContainerName (string $connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0)

	storeObjectToCache ()

	asStdClass ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy (int $new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	storeTranslation (IdentificationInterface $identification, string $language_key, string $translation)

static	storeDefaultTranslation (IdentificationInterface $identification, string $translation)

static	hasDefaultTranslation (IdentificationInterface $identification)

static	getDefaultLanguage ()

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField (string $old_name, string $new_name)

static	tableExists ()

static	fieldExists (string $field_name)

static	removeDBField (string $field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()
	@depracated never use in ILIAS Core, Plugins only More...

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...

static	findOrGetInstance ($primary_key, array $add_constructor_args=array())

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, array $fields=array(' *'), string $operator='=', $both_external=false)

static	innerjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)

static	leftjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)

static	orderBy ($orderBy, string $orderDirection='ASC')

static	dateFormat (string $date_format='d.m.Y - H:i:s')

static	limit ($start, $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $connector)

static	raw (bool $set_raw=true)

static	getArray (?string $key=null, $values=null)

static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Protected Attributes
string	$id
	@con_is_primary true @con_is_unique true @con_has_field true @con_fieldtype text @con_length 64 More...

string	$identification = ''
	@con_has_field true @con_fieldtype text @con_length 256 More...

string	$translation = ''
	@con_has_field true @con_fieldtype text @con_length 4000 More...

string	$language_key = ''
	@con_has_field true @con_fieldtype text @con_length 8 More...

string	$connector_container_name = "il_mm_translation"

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	@description Returns an instance of the instatiated calling active record (needs to be done in static methods) @TODO : This should be cached somehow More...

static	fromCamelCase (string $str)

Detailed Description

Class ilMMItemTranslationStorage.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

◆ getCache()

ilMMItemTranslationStorage::getCache ( )

@inheritDoc

Reimplemented from CachedActiveRecord.

Definition at line 211 of file class.ilMMItemTranslationStorage.php.

                              : ilGlobalCache
    {
        return ilGlobalCache::getInstance(ilGlobalCache::COMP_GLOBAL_SCREEN);
    }

References ilGlobalCache\COMP_GLOBAL_SCREEN, and ilGlobalCache\getInstance().

Here is the call graph for this function:

◆ getDefaultLanguage()

static ilMMItemTranslationStorage::getDefaultLanguage ( )

static

Returns: string

Definition at line 102 of file class.ilMMItemTranslationStorage.php.

                                               : string
    {
        static $default_language;
        global $DIC;
        if (!isset($default_language)) {
            $default_language = $DIC->language()->getDefaultLanguage() ? $DIC->language()->getDefaultLanguage() : "en";
        }
 
        return $default_language;
    }

References $DIC.

Referenced by hasDefaultTranslation().

Here is the caller graph for this function:

◆ getId()

ilMMItemTranslationStorage::getId ( )

Returns: string

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

                           : string
    {
        return $this->id;
    }

References $id.

◆ getIdentification()

ilMMItemTranslationStorage::getIdentification ( )

Returns: string

Definition at line 163 of file class.ilMMItemTranslationStorage.php.

                                       : string
    {
        return $this->identification;
    }

References $identification.

◆ getLanguageKey()

ilMMItemTranslationStorage::getLanguageKey ( )

Returns: string

Definition at line 195 of file class.ilMMItemTranslationStorage.php.

                                    : string
    {
        return $this->language_key;
    }

References $language_key.

◆ getTranslation()

ilMMItemTranslationStorage::getTranslation ( )

Returns: string

Definition at line 179 of file class.ilMMItemTranslationStorage.php.

                                    : string
    {
        return $this->translation;
    }

References $translation.

◆ hasDefaultTranslation()

static ilMMItemTranslationStorage::hasDefaultTranslation ( IdentificationInterface $identification )

static

Parameters

IdentificationInterface $identification

Returns: bool

Definition at line 91 of file class.ilMMItemTranslationStorage.php.

                                                                                         : bool
    {
        $lng = self::getDefaultLanguage();
        $key = "{$identification->serialize()}|$lng";
 
        return self::find($key) instanceof self;
    }

References ILIAS\LTI\ToolProvider\$key, $lng, and getDefaultLanguage().

Here is the call graph for this function:

◆ setId()

ilMMItemTranslationStorage::setId ( string $id )

Parameters

string $id

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

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

References $id.

◆ setIdentification()

ilMMItemTranslationStorage::setIdentification ( string $identification )

Parameters

string $identification

Definition at line 171 of file class.ilMMItemTranslationStorage.php.

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

References $identification.

◆ setLanguageKey()

ilMMItemTranslationStorage::setLanguageKey ( string $language_key )

Parameters

string $language_key

Definition at line 203 of file class.ilMMItemTranslationStorage.php.

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

References $language_key.

◆ setTranslation()

ilMMItemTranslationStorage::setTranslation ( string $translation )

Parameters

string $translation

Definition at line 187 of file class.ilMMItemTranslationStorage.php.

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

References $translation.

◆ storeDefaultTranslation()

static ilMMItemTranslationStorage::storeDefaultTranslation	(	IdentificationInterface	$identification,
		string	$translation
	)

static

Parameters

IdentificationInterface	$identification
string	$translation

Returns: ilMMItemTranslationStorage

Definition at line 61 of file class.ilMMItemTranslationStorage.php.

                                                                                                                : self
    {
        return self::storeTranslation($identification, self::getDefaultLanguage(), $translation);
    }

References $identification, $translation, and storeTranslation().

Referenced by ilMMAbstractItemFacade\create(), and ilMMAbstractItemFacade\update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeTranslation()

static ilMMItemTranslationStorage::storeTranslation	(	IdentificationInterface	$identification,
		string	$language_key,
		string	$translation
	)

static

Parameters

IdentificationInterface	$identification
string	$language_key
string	$translation

Returns: ilMMItemTranslationStorage

Definition at line 35 of file class.ilMMItemTranslationStorage.php.

                                                                                                                               : self
    {
        if ($translation === "-") {
            return new self();
        }
        $language_identification = "{$identification->serialize()}|$language_key";
        $mt = ilMMItemTranslationStorage::find($language_identification);
        if (!$mt instanceof ilMMItemTranslationStorage) {
            $mt = new ilMMItemTranslationStorage();
            $mt->setId($language_identification);
            $mt->setIdentification($identification->serialize());
            $mt->create();
        }
 
        $mt->setTranslation($translation);
        $mt->setLanguageKey($language_key);
        $mt->update();
 
        return $mt;
    }