Collaboration diagram for ilStudyProgrammeType:

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

	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 (DateTime $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	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...

	getActivePlugins ()

Protected Attributes
string	$default_lang = ''

int	$owner

DateTime	$create_date

DateTime	$last_update

string	$icon

ilObjUser	$user

array	$active_plugins

ilLanguage	$lng

array	$translations

array	$changed_translations = array()

int	$id = 0

ilStudyProgrammeTypeRepository	$type_repo

Filesystem	$webdir

ilComponentFactory	$component_factory

Private Attributes
const	WEB_DATA_FOLDER = 'prg_data'
	Folder in ILIAS webdir to store the icons. More...

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 29 of file class.ilStudyProgrammeType.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

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

References $component_factory, $id, $lng, $type_repo, $user, $webdir, ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ changedTranslations()

ilStudyProgrammeType::changedTranslations ( )

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

                                         : array
    {
        return $this->changed_translations;
    }

References $changed_translations.

◆ getActivePlugins()

ilStudyProgrammeType::getActivePlugins ( )

protected

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

                                         : Iterator
    {
        return $this->component_factory->getActivePluginsInSlot("prgtypehk");
    }

Referenced by updateable().

Here is the caller graph for this function:

◆ getCreateDate()

ilStudyProgrammeType::getCreateDate ( )

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

                                   : DateTime
    {
        return $this->create_date;
    }

References $create_date.

◆ getDefaultLang()

ilStudyProgrammeType::getDefaultLang ( )

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

                                    : string
    {
        return $this->default_lang;
    }

References $default_lang.

Referenced by getTranslation(), setDescription(), and setTitle().

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.

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

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

References getTranslation().

Here is the call graph for this function:

◆ getIcon()

ilStudyProgrammeType::getIcon ( )

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

                             : string
    {
        return $this->icon;
    }

References $icon.

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

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

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

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

References $path, getIcon(), and getId().

Referenced by processAndStoreIconFile(), and removeIconFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilStudyProgrammeType::getId ( )

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

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by getIconPath(), loadTranslation(), and updateAssignedStudyProgrammesIcons().

Here is the caller graph for this function:

◆ getLastUpdate()

ilStudyProgrammeType::getLastUpdate ( )

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

                                   : DateTime
    {
        return $this->last_update;
    }

References $last_update.

◆ getOwner()

ilStudyProgrammeType::getOwner ( )

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

                              : int
    {
        return $this->owner;
    }

References $owner.

◆ getRepository()

ilStudyProgrammeType::getRepository ( )

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

                                   : ilStudyProgrammeTypeRepository
    {
        return $this->type_repo;
    }

References $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.

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

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

References getTranslation().

Here is the call 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

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

                                                                        : ?string
    {
        $lang = ($lang_code) ?: $this->user->getLanguage();
 
        $trans_obj = $this->loadTranslation($lang);
        if (!is_null($trans_obj)) {
            $translation = $trans_obj[$member] ?? null;
            // 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] ?? null;
            }
 
            return $translation;
        }
 
        // 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] ?? null;
        }
 
        return null;
    }

References $lang, getDefaultLang(), loadTranslation(), and ILIAS\Repository\user().

Referenced by getDescription(), and getTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslations()

ilStudyProgrammeType::getTranslations ( )

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

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

References $translations.

◆ loadTranslation()

ilStudyProgrammeType::loadTranslation ( string $lang_code )

protected

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

                                                         : ?array
    {
        if (isset($this->translations[$lang_code])) {
            return $this->translations[$lang_code];
        } else {
            $trans_array = $this->type_repo->getTranslationsByTypeAndLang($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;
    }

References getId().

Referenced by getTranslation().

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

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

                                                             : 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());
        }
 
        if ($this->webdir->has($this->getIconPath(true))) {
            $this->webdir->delete($this->getIconPath(true));
        }
 
        $stream = ILIAS\Filesystem\Stream\Streams::ofResource(fopen($file_data["tmp_name"], 'rb'));
        $this->webdir->writeStream($this->getIconPath(true), $stream);
 
        return true;
    }

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

Here is the call graph for this function:

◆ removeIconFile()

ilStudyProgrammeType::removeIconFile ( )

Remove the icon file on disk.

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

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

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

Here is the call graph for this function:

◆ setCreateDate()

ilStudyProgrammeType::setCreateDate ( DateTime $create_date )

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

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

References $create_date.

◆ setDefaultLang()

ilStudyProgrammeType::setDefaultLang ( string $default_lang )

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

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

References $default_lang.

◆ setDescription()

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

Set description of StudyProgramme type.

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

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

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

References $lang, and getDefaultLang().

Here is the call 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.

Exceptions

ilStudyProgrammeTypeException

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

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

References $icon.

Referenced by removeIconFile().

Here is the caller graph for this function:

◆ setLastUpdate()

ilStudyProgrammeType::setLastUpdate ( DateTime $last_update )

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

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

References $last_update.

◆ setOwner()

ilStudyProgrammeType::setOwner ( int $owner )

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

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

References $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.

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

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

References $lang, and getDefaultLang().

Here is the call graph for this function:

◆ setTranslations()

ilStudyProgrammeType::setTranslations ( array $translations )

Getters & Setters.

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

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

References $translations.

◆ updateable()

ilStudyProgrammeType::updateable ( )

protected

Helper function to check if this type can be updated.

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

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

References XapiProxy\$plugin, and getActivePlugins().

Referenced by processAndStoreIconFile(), and removeIconFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateAssignedStudyProgrammesIcons()

ilStudyProgrammeType::updateAssignedStudyProgrammesIcons ( )

Update the Icons of assigned objects.

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

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