Inheritance diagram for ilStudyProgrammeType:

Collaboration diagram for ilStudyProgrammeType:

Public Member Functions
	__construct ($primary_key=0)

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

	setTitle ($a_title, $a_lang_code='')
	Set title of StudyProgramme type. More...

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

	setDescription ($a_description, $a_lang_code='')
	Set description of StudyProgramme type. More...

	getAssignedStudyProgrammes ($include_deleted=true)
	Get an array of ilObjStudyProgramme objects using this type. More...

	getAssignedStudyProgrammeIds ()

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

	getAssignedAdvancedMDRecords ($a_only_active=false)
	Get assigned AdvancedMDRecord 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 ($translations)
	Getters & Setters. More...

	getTranslations ()
	Returns the loaded translation objects. More...

	setOwner ($owner)

	getOwner ()

	setLastUpdate ($last_update)

	getLastUpdate ()

	getId ()

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

	getIcon ()

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

	getDefaultLang ()

	setCreateDate ($create_date)

	getCreateDate ()

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()

	setConnectorContainerName ($connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0, arConnector $connector=null)

	storeObjectToCache ()

	__getConvertedDateFieldsAsArray ($format=null)

	__asCsv ($separator=';', $header=false)

	__asArray ()

	__asStdClass ()

	__asSerializedObject ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForDb ()

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy ($new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()

static	getAllTypes ()
	Public. More...

static	getAllTypesArray ($add_empty_on_begin=true)

static	getAvailableAdvancedMDRecords ()
	Get all available AdvancedMDRecord objects for StudyProgrammes/Types. More...

static	getIconPathByStudyProgrammObjId ($obj_id)
	Return the path to the icon by studyprogramme obj id. More...

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField ($old_name, $new_name)

static	tableExists ()

static	fieldExists ($field_name)

static	removeDBField ($field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()

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, $fields=array(' *'), $operator='=', $both_external=false)

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

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

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

static	dateFormat ($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 ($set_raw=true)

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

static	_toCamelCase ($str, $capitalise_first_char=false)

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

Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Member Functions
	getTranslation ($a_member, $a_lang_code)
	Protected. More...

	loadTranslation ($a_lang_code)
	Helper function to load a translation. More...

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

Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...

	installDatabase ()

Protected Attributes
	$id = 0

	$default_lang = ''

	$owner

	$create_date

	$last_update

	$icon

	$amd_records_assigned

	$log

	$user

	$pluginAdmin

	$active_plugins

	$lng

	$translations

	$changed_translations = array()

Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true

	$connector_container_name = ''

Static Protected Attributes
static	$amd_records_available

Additional Inherited Members
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()

static	fromCamelCase ($str)

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeType::__construct ( $primary_key = 0 )

Parameters

int $a_id

Exceptions

ilStudyProgrammeTypeException

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilLog = $DIC['ilLog'];
        $ilUser = $DIC['ilUser'];
        $ilPluginAdmin = $DIC['ilPluginAdmin'];
        $lng = $DIC['lng'];
 
        $this->webdir = $DIC->filesystem()->web();
        $this->db = $ilDB;
        $this->log = $ilLog;
        $this->user = $ilUser;
        $this->pluginAdmin = $ilPluginAdmin;
        $this->lng = $lng;
 
        parent::__construct($primary_key);
    }

References $DIC, $ilDB, $ilLog, $ilUser, $lng, and user().

Here is the call graph for this function:

Member Function Documentation

◆ getAllTypes()

static ilStudyProgrammeType::getAllTypes ( )

static

Public.

Get array of all instances of ilStudyProgrammeType objects

Returns: array

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

    {
        return self::get();
    }

References ActiveRecord\get().

Here is the call graph for this function:

◆ getAllTypesArray()

static ilStudyProgrammeType::getAllTypesArray ( $add_empty_on_begin = true )

static

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

    {
        $out = array();
 
        foreach (self::getAllTypes() as $type) {
            $out[$type->getId()] = $type->getTitle();
        }
 
        if ($add_empty_on_begin) {
            $out = array('-'=>'-') + $out;
        }
 
        return $out;
    }

References $out, and $type.

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

Here is the caller graph for this function:

◆ getAssignedAdvancedMDRecords()

ilStudyProgrammeType::getAssignedAdvancedMDRecords ( $a_only_active = false )

Get assigned AdvancedMDRecord objects.

Parameters

bool $a_only_active True if only active AMDRecords are returned

Returns: array

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

    {
        $active = ($a_only_active) ? 1 : 0; // Cache key
        if (is_array($this->amd_records_assigned[$active])) {
            return $this->amd_records_assigned[$active];
        }
        $this->amd_records_assigned[$active] = array();
        $sets = ilStudyProgrammeAdvancedMetadataRecord::where(array('type_id'=>$this->getId()))->get();
 
        foreach ($sets as $set) {
            $amd_record = new ilAdvancedMDRecord($set->getRecId());
            if ($a_only_active) {
                if ($amd_record->isActive()) {
                    $this->amd_records_assigned[1][] = $amd_record;
                }
            } else {
                $this->amd_records_assigned[0][] = $amd_record;
            }
        }
 
        return $this->amd_records_assigned[$active];
    }

References $sets, getId(), and ActiveRecord\where().

Here is the call graph for this function:

◆ getAssignedStudyProgrammeIds()

ilStudyProgrammeType::getAssignedStudyProgrammeIds ( )

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

    {
        $study_programmes = $this->getAssignedStudyProgrammes();
 
        $out = array();
        foreach ($study_programmes as $study_program) {
            $out[] = $study_program->getObjId();
        }
 
        return $out;
    }

References $out, and getAssignedStudyProgrammes().

Referenced by updateAssignedStudyProgrammesIcons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignedStudyProgrammes()

ilStudyProgrammeType::getAssignedStudyProgrammes ( $include_deleted = true )

Get an array of ilObjStudyProgramme objects using this type.

Parameters

bool $include_deleted True if also deleted StudyProgrammes are returned

Returns: array

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

    {
        return ilStudyProgramme::where(array('subtype_id'=>$this->getId()))->get();
    }

References getId(), and ActiveRecord\where().

Referenced by getAssignedStudyProgrammeIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableAdvancedMDRecords()

static ilStudyProgrammeType::getAvailableAdvancedMDRecords ( )

static

Get all available AdvancedMDRecord objects for StudyProgrammes/Types.

Returns: array

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

    {
        if (is_array(self::$amd_records_available)) {
            return self::$amd_records_available;
        }
        self::$amd_records_available = ilAdvancedMDRecord::_getActivatedRecordsByObjectType('prg', 'prg_type');
 
        return self::$amd_records_available;
    }

References $amd_records_available, and ilAdvancedMDRecord\_getActivatedRecordsByObjectType().

Here is the call graph for this function:

◆ getCreateDate()

ilStudyProgrammeType::getCreateDate ( )

Returns: string

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

    {
        return $this->create_date;
    }

References $create_date.

◆ getDefaultLang()

ilStudyProgrammeType::getDefaultLang ( )

Returns: string

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

    {
        return $this->default_lang;
    }

References $default_lang.

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

Here is the caller graph for this function:

◆ getDescription()

ilStudyProgrammeType::getDescription ( $a_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 364 of file class.ilStudyProgrammeType.php.

    {
        return $this->getTranslation('description', $a_lang_code);
    }

References getTranslation().

Here is the call graph for this function:

◆ getIcon()

ilStudyProgrammeType::getIcon ( )

Returns: string

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

    {
        return $this->icon;
    }

References $icon.

Referenced by getIconPath(), processAndStoreIconFile(), and removeIconFile().

Here is the caller graph for this function:

◆ getIconPath()

ilStudyProgrammeType::getIconPath ( $append_filename = false )

Return the path to the icon.

Parameters

bool $append_filename If true, append filename of icon

Returns: string

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

    {
        $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:

◆ getIconPathByStudyProgrammObjId()

static ilStudyProgrammeType::getIconPathByStudyProgrammObjId ( $obj_id )

static

Return the path to the icon by studyprogramme obj id.

Parameters

int $obj_id study prgramm obj id

Returns: string icon path

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $sql = "SELECT prgt.id, prgt.icon\n"
                . " FROM prg_type prgt\n"
                . " JOIN prg_settings prgs\n"
                    . " ON prgt.id = prgs.subtype_id\n"
                . " WHERE prgs.obj_id = " . $ilDB->quote($obj_id, "integer") . "\n";
 
        $res = $ilDB->query($sql);
 
        if ($ilDB->numRows($res) == 1) {
            $row = $ilDB->fetchAssoc($res);
 
            if ($row["icon"]) {
                $path = self::WEB_DATA_FOLDER . '/' . 'type_' . $row["id"] . '/';
                $path .= $row["icon"];
 
                return $path;
            }
 
            return null;
        }
 
        return null;
    }

References $DIC, $ilDB, $path, $res, and $row.

◆ getId()

ilStudyProgrammeType::getId ( )

Returns: int

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

    {
        return $this->id;
    }

References $id.

Referenced by getAssignedAdvancedMDRecords(), getAssignedStudyProgrammes(), getIconPath(), and loadTranslation().

Here is the caller graph for this function:

◆ getLastUpdate()

ilStudyProgrammeType::getLastUpdate ( )

Returns: string

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

    {
        return $this->last_update;
    }

References $last_update.

◆ getOwner()

ilStudyProgrammeType::getOwner ( )

Returns: int

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

    {
        return $this->owner;
    }

References $owner.

◆ getTitle()

ilStudyProgrammeType::getTitle ( $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 335 of file class.ilStudyProgrammeType.php.

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

References getTranslation().

Here is the call graph for this function:

◆ getTranslation()

ilStudyProgrammeType::getTranslation	(	$a_member,
		$a_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 657 of file class.ilStudyProgrammeType.php.

    {
        $lang = ($a_lang_code) ? $a_lang_code : $this->user->getLanguage();
 
        $trans_obj = $this->loadTranslation($lang);
        if (!is_null($trans_obj)) {
            $translation = $trans_obj[$a_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 (!$a_lang_code && !$translation) {
                $trans_obj = $this->loadTranslation($this->getDefaultLang());
 
                return $trans_obj[$a_member];
            }
 
            return $translation;
        } else {
            // If no lang code was given and there was no translation found, return string in default language
            if (!$a_lang_code) {
                $trans_obj = $this->loadTranslation($this->getDefaultLang());
 
                return $trans_obj[$a_member];
            }
 
            return null;
        }
    }

References $lang, getDefaultLang(), loadTranslation(), and 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 ( )

Returns the loaded translation objects.

Returns: array

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

    {
        return $this->translations;
    }

References $translations.

◆ loadTranslation()

ilStudyProgrammeType::loadTranslation ( $a_lang_code )

protected

Helper function to load a translation.

Returns translation object from cache or null, if no translation exists for the given code.

Parameters

string $a_lang_code A language code

Returns: ActiveRecordList|null

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

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

References ActiveRecord\count(), getId(), and ActiveRecord\where().

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

Returns: bool

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

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

References $filename, GuzzleHttp\Psr7\$stream, ActiveRecord\count(), getIcon(), 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 632 of file class.ilStudyProgrammeType.php.

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

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

Here is the call graph for this function:

◆ returnDbTableName()

static ilStudyProgrammeType::returnDbTableName ( )

static

Returns: string @description Return the Name of your Database Table

Deprecated:

Reimplemented from ActiveRecord.

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

    {
        return 'prg_type';
    }

◆ setCreateDate()

ilStudyProgrammeType::setCreateDate ( $create_date )

Parameters

string $create_date

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

    {
        $this->create_date = $create_date;
    }

References $create_date.

◆ setDescription()

ilStudyProgrammeType::setDescription	(	$a_description,
		$a_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 377 of file class.ilStudyProgrammeType.php.

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

References $lang, and getDefaultLang().

Here is the call graph for this function:

◆ setIcon()

ilStudyProgrammeType::setIcon ( $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 906 of file class.ilStudyProgrammeType.php.

    {
        if ($icon and !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 ( $last_update )

Parameters

string $last_update

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

    {
        $this->last_update = $last_update;
    }

References $last_update.

◆ setOwner()

ilStudyProgrammeType::setOwner ( $owner )

Parameters

int $owner

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

    {
        $this->owner = $owner;
    }

References $owner.

◆ setTitle()

ilStudyProgrammeType::setTitle	(	$a_title,
		$a_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 348 of file class.ilStudyProgrammeType.php.

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

References $lang, and getDefaultLang().

Here is the call graph for this function:

◆ setTranslations()

ilStudyProgrammeType::setTranslations ( $translations )

Getters & Setters.

Parameters

array $translations

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

    {
        $this->translations = $translations;
    }

References $translations.

◆ updateable()

ilStudyProgrammeType::updateable ( )

protected

Helper function to check if this type can be updated.

Returns: bool

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

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

Referenced by processAndStoreIconFile(), and removeIconFile().

Here is the caller graph for this function:

◆ updateAssignedStudyProgrammesIcons()

ilStudyProgrammeType::updateAssignedStudyProgrammesIcons ( )

Update the Icons of assigned objects.

Returns: void

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

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