aboutsummaryrefslogtreecommitdiff
path: root/lib/models/ModulDeskriptor.php
blob: d9da0bbcf197ae52a98da60e30777f739f28d327 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?php
/**
 * ModulDeskriptor.php
 * Model class for Moduldeskriptoren (table mvv_modul_deskriptor)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * @author      Peter Thienel <thienel@data-quest.de>
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 * @since       3.5
 *
 * @property string $id alias column for deskriptor_id
 * @property string $deskriptor_id database column
 * @property string $modul_id database column
 * @property I18NString|null $verantwortlich database column
 * @property I18NString|null $bezeichnung database column
 * @property I18NString|null $voraussetzung database column
 * @property I18NString|null $kompetenzziele database column
 * @property I18NString|null $inhalte database column
 * @property I18NString|null $literatur database column
 * @property I18NString|null $links database column
 * @property I18NString|null $kommentar database column
 * @property I18NString|null $turnus database column
 * @property I18NString|null $kommentar_kapazitaet database column
 * @property I18NString|null $kommentar_sws database column
 * @property I18NString|null $kommentar_wl_selbst database column
 * @property I18NString|null $kommentar_wl_pruef database column
 * @property I18NString|null $kommentar_note database column
 * @property I18NString|null $pruef_vorleistung database column
 * @property I18NString|null $pruef_leistung database column
 * @property I18NString|null $pruef_wiederholung database column
 * @property I18NString|null $ersatztext database column
 * @property string|null $author_id database column
 * @property string|null $editor_id database column
 * @property int $mkdate database column
 * @property int $chdate database column
 * @property SimpleORMapCollection<DatafieldEntryModel> $datafields has_many DatafieldEntryModel
 * @property Modul $modul belongs_to Modul
 */

class ModulDeskriptor extends ModuleManagementModel
{
    protected static function configure($config = [])
    {
        $config['db_table'] = 'mvv_modul_deskriptor';

        $config['belongs_to']['modul'] = [
            'class_name' => Modul::class,
            'foreign_key' => 'modul_id',
            'assoc_func' => 'findCached',
        ];

        $config['has_many']['datafields'] = [
            'class_name' => DatafieldEntryModel::class,
            'assoc_foreign_key' =>
                function($model, $params) {
                    $model->setValue('range_id', $params[0]->id);
                },
            'assoc_func' => 'findByModel',
            'on_delete' => 'delete',
            'on_store' => 'store',
            'foreign_key' =>
                function($m) {
                    return [$m];
                }
        ];

        $config['i18n_fields']['verantwortlich'] = true;
        $config['i18n_fields']['bezeichnung'] = true;
        $config['i18n_fields']['voraussetzung'] = true;
        $config['i18n_fields']['kompetenzziele'] = true;
        $config['i18n_fields']['inhalte'] = true;
        $config['i18n_fields']['literatur'] = true;
        $config['i18n_fields']['links'] = true;
        $config['i18n_fields']['kommentar'] = true;
        $config['i18n_fields']['turnus'] = true;
        $config['i18n_fields']['kommentar_kapazitaet'] = true;
        $config['i18n_fields']['kommentar_sws'] = true;
        $config['i18n_fields']['kommentar_wl_selbst'] = true;
        $config['i18n_fields']['kommentar_wl_pruef'] = true;
        $config['i18n_fields']['kommentar_note'] = true;
        $config['i18n_fields']['pruef_vorleistung'] = true;
        $config['i18n_fields']['pruef_leistung'] = true;
        $config['i18n_fields']['pruef_wiederholung'] = true;
        $config['i18n_fields']['ersatztext'] = true;

        parent::configure($config);
    }

    public function __construct($id = null)
    {
        parent::__construct($id);
        $this->object_real_name = _('Modul-Deskriptor');
    }

    /**
     * @see ModuleManagementModel::getClassDisplayName
     */
    public static function getClassDisplayName($long = false)
    {
        return _('Modul-Deskriptor');
    }

    /**
     * Inherits the status of the parent module.
     *
     * @return string The status (see mvv_config.php)
     */
    public function getStatus()
    {
        if ($this->modul) {
            return $this->modul->getStatus();
        }
        if ($this->isNew()) {
            return $GLOBALS['MVV_MODUL']['STATUS']['default'];
        }
        return parent::getStatus();
    }

    public function getResponsibleInstitutes()
    {
        $institutes = [];
        $modul_insts = ModulInst::findByModul($this->modul_id, 'hauptverantwortlich');
        foreach ($modul_insts as $modul_inst) {
            $institute = Institute::find($modul_inst->institut_id);
            if ($institute) {
                $institutes[] = $institute;
            }
        }
        return $institutes;
    }

    /**
     * Returns the language identifier as the variant of the descriptor object.
     *
     * @see ModuleManagementModel::getVariant()
     * @return string The language identifier.
     */
    public function getVariant(): string
    {
        if (self::getLanguage() === Config::get()->MVV_DEFAULT_LANGUAGE) {
            return '';
        }
        $splitted_code = explode('_', self::getLanguage());
        return mb_strtoupper($splitted_code[0] ?? '');
    }

    /**
     * Deletes the translation in the given language of this descriptor.
     *
     * @param string $language The language of the translation to delete.
     * @return int The number of deleted translated fields.
     */
    public function deleteTranslation($language)
    {
        return I18NString::removeAllTranslations($this->id, 'mvv_modul_deskriptor', $language);
    }
}