Collaboration diagram for ilStudyProgrammeType:

Public Member Functions
	__construct (int $id, ilStudyProgrammeTypeRepository $type_repo, ILIAS\Filesystem\Filesystem $webdir, ilPluginAdmin $plugin_admin, ilLanguage $lng, ilObjUser $user)

	getTitle (string $a_lang_code='')
	Get the title of an StudyProgramme type. More...

	setTitle (string $title, string $lang_code='')
	Set title of StudyProgramme type. More...

	getDescription (string $lang_code='')
	Get the description of an StudyProgramme type. More...

	setDescription (string $description, string $lang_code='')
	Set description of StudyProgramme type. More...

	updateAssignedStudyProgrammesIcons ()
	Update the Icons of assigned objects. More...

	processAndStoreIconFile (array $file_data)
	Resize and store an icon file for this object. More...

	removeIconFile ()
	Remove the icon file on disk. More...

	setTranslations (array $translations)
	Getters & Setters. More...

	getTranslations ()

	setOwner (int $owner)

	getOwner ()

	setLastUpdate ($last_update)

	getLastUpdate ()

	getId ()

	setIcon (string $icon)
	Set new Icon filename. More...

	getIcon ()

	getIconPath (bool $append_filename=false)
	Return the path to the icon. More...

	setDefaultLang (string $default_lang)

	getDefaultLang ()

	setCreateDate (DateTime $create_date)

	getCreateDate ()

	getRepository ()

	changedTranslations ()

Data Fields
const	WEB_DATA_FOLDER = 'prg_data'
	Folder in ILIAS webdir to store the icons. More...

const	DATE_TIME_FORMAT = 'Y-m-d H:i:s'

const	DATE_FORMAT = 'Y-m-d'

Protected Member Functions
	getTranslation (string $member, string $lang_code)
	Protected. More...

	loadTranslation (string $lang_code)

	updateable ()
	Helper function to check if this type can be updated. More...

Protected Attributes
	$id = 0

	$default_lang = ''

	$owner

	$create_date

	$last_update

	$icon

	$amd_records_assigned

	$log

	$user

	$plugin_admin

	$active_plugins

	$lng

	$translations

	$changed_translations = array()

Static Protected Attributes
static	$amd_records_available

Detailed Description

Class ilStudyProgrammeType.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeType::__construct	(	int	$id,
		ilStudyProgrammeTypeRepository	$type_repo,
		ILIAS\Filesystem\Filesystem	$webdir,
		ilPluginAdmin	$plugin_admin,
		ilLanguage	$lng,
		ilObjUser	$user
	)

Parameters

int $a_id

Exceptions

ilStudyProgrammeTypeException

Definition at line 100 of file class.ilStudyProgrammeType.php.

References $id, $lng, $plugin_admin, $user, and user().

       {
         $this->id = $id;
         $this->type_repo = $type_repo;
         $this->webdir = $webdir;
         $this->plugin_admin = $plugin_admin;
         $this->lng = $lng;
         $this->user = $user;
     }

Here is the call graph for this function:

Member Function Documentation

◆ changedTranslations()

ilStudyProgrammeType::changedTranslations ( )

Definition at line 629 of file class.ilStudyProgrammeType.php.

References $changed_translations.

                                           : array
     {
         return $this->changed_translations;
     }

◆ getCreateDate()

ilStudyProgrammeType::getCreateDate ( )

Returns: string

Definition at line 604 of file class.ilStudyProgrammeType.php.

References $create_date.

Referenced by ilStudyProgrammeTypeDBRepository\updateType().

     {
         return $this->create_date;
     }

Here is the caller graph for this function:

◆ getDefaultLang()

ilStudyProgrammeType::getDefaultLang ( )

Returns: string

Definition at line 586 of file class.ilStudyProgrammeType.php.

References $default_lang.

Referenced by ilStudyProgrammeTypeGUI\buildForm(), getTranslation(), setDescription(), setTitle(), and ilStudyProgrammeTypeDBRepository\updateType().

                                      : string
     {
         return $this->default_lang;
     }

Here is the caller graph for this function:

◆ getDescription()

ilStudyProgrammeType::getDescription ( string $lang_code = '' )

Get the description of an StudyProgramme type.

If no language code is given, a translation in the user-language is returned. If no such translation exists, the description of the default language is substituted. If a language code is provided, returns description for the given language or null.

Parameters

string $a_lang_code

Returns: null|string

Definition at line 154 of file class.ilStudyProgrammeType.php.

References getTranslation().

Referenced by ilStudyProgrammeTypeGUI\buildLanguagesForms().

                                                            : string
     {
         return (string) $this->getTranslation('description', $lang_code);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIcon()

ilStudyProgrammeType::getIcon ( )

Returns: string

Definition at line 548 of file class.ilStudyProgrammeType.php.

References $icon.

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\fillForm(), getIconPath(), processAndStoreIconFile(), removeIconFile(), and ilStudyProgrammeTypeDBRepository\updateType().

     {
         return $this->icon;
     }

Here is the caller graph for this function:

◆ getIconPath()

ilStudyProgrammeType::getIconPath ( bool $append_filename = false )

Return the path to the icon.

Parameters

bool $append_filename If true, append filename of icon

Returns: string

Definition at line 561 of file class.ilStudyProgrammeType.php.

References getIcon(), and getId().

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\fillForm(), processAndStoreIconFile(), removeIconFile(), and ilStudyProgrammeTypeDBRepository\updateRowTypeTranslationDB().

     {
         $path = self::WEB_DATA_FOLDER . '/' . 'type_' . $this->getId() . '/';
         if ($append_filename) {
             $path .= $this->getIcon();
         }
 
         return $path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilStudyProgrammeType::getId ( )

Returns: int

Definition at line 518 of file class.ilStudyProgrammeType.php.

References $id.

Referenced by ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillForm(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\fillObject(), getIconPath(), loadTranslation(), setTranslations(), updateAssignedStudyProgrammesIcons(), ilStudyProgrammeTypeDBRepository\updateRowTypeTranslationDB(), and ilStudyProgrammeTypeDBRepository\updateType().

                             : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getLastUpdate()

ilStudyProgrammeType::getLastUpdate ( )

Returns: string

Definition at line 509 of file class.ilStudyProgrammeType.php.

References $last_update.

Referenced by ilStudyProgrammeTypeDBRepository\updateType().

     {
         return $this->last_update;
     }

Here is the caller graph for this function:

◆ getOwner()

ilStudyProgrammeType::getOwner ( )

Returns: int

Definition at line 491 of file class.ilStudyProgrammeType.php.

References $owner.

Referenced by ilStudyProgrammeTypeDBRepository\updateType().

     {
         return $this->owner;
     }

Here is the caller graph for this function:

◆ getRepository()

ilStudyProgrammeType::getRepository ( )

Definition at line 609 of file class.ilStudyProgrammeType.php.

References $active_plugins, XapiProxy\$plugin, and IL_COMP_MODULE.

                                     : ilStudyProgrammeTypeRepository
     {
         return $this->type_repo;
     }

◆ getTitle()

ilStudyProgrammeType::getTitle ( string $a_lang_code = '' )

Get the title of an StudyProgramme type.

If no language code is given, a translation in the user-language is returned. If no such translation exists, the translation of the default language is substituted. If a language code is provided, returns title for the given language or null.

Parameters

string $a_lang_code

Returns: null|string

Definition at line 125 of file class.ilStudyProgrammeType.php.

References getTranslation().

Referenced by ilStudyProgrammeTypeGUI\buildLanguagesForms().

                                                        : string
     {
         return (string) $this->getTranslation('title', $a_lang_code);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslation()

ilStudyProgrammeType::getTranslation	(	string	$member,
		string	$lang_code
	)

protected

Protected.

Helper method to return a translation for a given member and language

Parameters

$a_member
$a_lang_code

Returns: null|string

Definition at line 345 of file class.ilStudyProgrammeType.php.

References $lang, getDefaultLang(), loadTranslation(), and user().

Referenced by getDescription(), getTitle(), and setTranslations().

     {
         $lang = ($lang_code) ? $lang_code : $this->user->getLanguage();
 
         $trans_obj = $this->loadTranslation($lang);
         if (!is_null($trans_obj)) {
             $translation = $trans_obj[$member];
             // If the translation does exist but is an empty string and there was no lang code given,
             // substitute default language anyway because an empty string provides no information
             if (!$lang_code && !$translation) {
                 $trans_obj = $this->loadTranslation($this->getDefaultLang());
 
                 return $trans_obj[$member];
             }
 
             return $translation;
         } else {
             // If no lang code was given and there was no translation found, return string in default language
             if (!$lang_code) {
                 $trans_obj = $this->loadTranslation($this->getDefaultLang());
 
                 return $trans_obj[$member];
             }
 
             return null;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslations()

ilStudyProgrammeType::getTranslations ( )

Definition at line 474 of file class.ilStudyProgrammeType.php.

References $translations.

                                       : ?array
     {
         return $this->translations;
     }

◆ loadTranslation()

ilStudyProgrammeType::loadTranslation ( string $lang_code )

protected

Definition at line 373 of file class.ilStudyProgrammeType.php.

References getId().

Referenced by getTranslation().

     {
         if (isset($this->translations[$lang_code])) {
             return $this->translations[$lang_code];
         } else {
             $trans_array = $this->type_repo->readTranslationsByTypeAndLang($this->getId(), $lang_code);
 
             //ilStudyProgrammeTypeTranslation::where(array('prg_type_id'=>$this->getId(), 'lang'=>$a_lang_code))->getArray('member', 'value');
             if (count($trans_array)) {
                 $this->translations[$lang_code] = $trans_array;
 
                 return $trans_array;
             }
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processAndStoreIconFile()

ilStudyProgrammeType::processAndStoreIconFile ( array $file_data )

Resize and store an icon file for this object.

Parameters

array $file_data The array containing file information from the icon from PHPs $_FILES array

Returns: bool

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

References $filename, getIcon(), getIconPath(), ILIAS\Filesystem\Stream\Streams\ofResource(), and updateable().

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\fillForm().

                                                               : bool
     {
         if (!$this->updateable()) {
             return false;
         }
         if (!count($file_data) || !$file_data['name']) {
             return false;
         }
         if (!$this->webdir->hasDir($this->getIconPath())) {
             $this->webdir->createDir($this->getIconPath());
         }
 
         $filename = $this->getIcon() ? $this->getIcon() : $file_data['name'];
 
         if ($this->webdir->has($this->getIconPath(true))) {
             $this->webdir->delete($this->getIconPath(true));
         }
 
         $stream = ILIAS\Filesystem\Stream\Streams::ofResource(fopen($file_data["tmp_name"], "r"));
         $this->webdir->writeStream($this->getIconPath(true), $stream);
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeIconFile()

ilStudyProgrammeType::removeIconFile ( )

Remove the icon file on disk.

Definition at line 317 of file class.ilStudyProgrammeType.php.

References getIcon(), getIconPath(), setIcon(), and updateable().

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\fillForm().

     {
         if (!$this->updateable()) {
             return;
         }
 
         if (
             !is_null($this->getIcon()) &&
             $this->getIcon() !== ""
         ) {
             $this->webdir->delete($this->getIconPath(true));
             $this->setIcon('');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCreateDate()

ilStudyProgrammeType::setCreateDate ( DateTime $create_date )

Parameters

string $create_date

Definition at line 595 of file class.ilStudyProgrammeType.php.

References $create_date.

     {
         $this->create_date = $create_date;
     }

◆ setDefaultLang()

ilStudyProgrammeType::setDefaultLang ( string $default_lang )

Parameters

string $default_lang

Exceptions

ilStudyProgrammeTypePluginException

Definition at line 577 of file class.ilStudyProgrammeType.php.

References $default_lang.

Referenced by ilStudyProgrammeTypeGUI\update().

     {
         $this->default_lang = $default_lang;
     }

Here is the caller graph for this function:

◆ setDescription()

ilStudyProgrammeType::setDescription	(	string	$description,
		string	$lang_code = `''`
	)

Set description of StudyProgramme type.

If no lang code is given, sets description for default language.

Parameters

	$a_description
string	$a_lang_code

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

References $lang, and getDefaultLang().

Referenced by ilStudyProgrammeTypeGUI\update().

     {
         $lang = ($lang_code) ? $lang_code : $this->getDefaultLang();
         $this->setTranslation('description', $description, $lang);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIcon()

ilStudyProgrammeType::setIcon ( string $icon )

Set new Icon filename.

Note that if you did also send a new icon image file with a form, make sure to call ilStudyProgrammeType::processAndStoreIconFile() to store the file additionally on disk.

If you want to delete the icon, set call ilStudyProgrammeType::removeIconFile() first and set an empty string here.

Parameters

string $icon

Exceptions

ilStudyProgrammeTypeException

Definition at line 536 of file class.ilStudyProgrammeType.php.

References $icon.

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\fillForm(), and removeIconFile().

     {
         if ($icon and !preg_match('/\.(svg)$/', $icon)) {
             throw new ilStudyProgrammeTypeException('Icon must be set with file extension svg');
         }
         $this->icon = $icon;
     }

Here is the caller graph for this function:

◆ setLastUpdate()

ilStudyProgrammeType::setLastUpdate ( $last_update )

Parameters

string $last_update

Definition at line 500 of file class.ilStudyProgrammeType.php.

References $last_update.

     {
         $this->last_update = $last_update;
     }

◆ setOwner()

ilStudyProgrammeType::setOwner ( int $owner )

Parameters

int $owner

Definition at line 482 of file class.ilStudyProgrammeType.php.

References $owner.

     {
         $this->owner = $owner;
     }

◆ setTitle()

ilStudyProgrammeType::setTitle	(	string	$title,
		string	$lang_code = `''`
	)

Set title of StudyProgramme type.

If no lang code is given, sets title for default language.

Parameters

	$a_title
string	$a_lang_code

Definition at line 138 of file class.ilStudyProgrammeType.php.

References $lang, and getDefaultLang().

Referenced by ilStudyProgrammeTypeGUI\update().

     {
         $lang = ($lang_code) ? $lang_code : $this->getDefaultLang();
         $this->setTranslation('title', $title, $lang);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTranslations()

ilStudyProgrammeType::setTranslations ( array $translations )

Getters & Setters.

Parameters

array $translations

Definition at line 415 of file class.ilStudyProgrammeType.php.

References XapiProxy\$plugin, $translations, getId(), and getTranslation().

     {
         $this->translations = $translations;
     }

Here is the call graph for this function:

◆ updateable()

ilStudyProgrammeType::updateable ( )

protected

Helper function to check if this type can be updated.

Returns: bool

Definition at line 396 of file class.ilStudyProgrammeType.php.

References XapiProxy\$plugin.

Referenced by processAndStoreIconFile(), and removeIconFile().

                                     : bool
     {
         foreach ($this->getActivePlugins() as $plugin) {
             if (!$plugin->allowUpdate($this->getId())) {
                 return false;
             }
         }
 
         return true;
     }

Here is the caller graph for this function:

◆ updateAssignedStudyProgrammesIcons()

ilStudyProgrammeType::updateAssignedStudyProgrammesIcons ( )

Update the Icons of assigned objects.

Returns: void

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

References $id, XapiProxy\$plugin, ilObject\_getAllReferences(), getId(), ilObjStudyProgramme\getInstanceByRefId(), and ilAdvancedMDRecord\saveObjRecSelection().

Referenced by ilStudyProgrammeTypeCustomIconsFormGUI\saveObject().

     {
         $obj_ids = $this->type_repo->readStudyProgrammeIdsByTypeId($this->getId());
 
         foreach ($obj_ids as $id) {
             $ref_id = ilObject::_getAllReferences($id);
             $osp = ilObjStudyProgramme::getInstanceByRefId(array_pop($ref_id));
             $osp->updateCustomIcon();
         }
     }