aboutsummaryrefslogtreecommitdiff
path: root/lib/models/StgteilabschnittModul.php
blob: d871df6b4ab8001e5a178aa505ea465148f0ad02 (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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<?php
/**
 * StgteilabschnittModul.php
 * Model class for the relation between Studiengangteil-Abschnitte and Module
 * (table mvv_stgteilabschnitt_modul)
 *
 * 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 abschnitt_modul_id
 * @property string $abschnitt_modul_id database column
 * @property string $abschnitt_id database column
 * @property string $modul_id database column
 * @property string|null $flexnow_modul database column
 * @property string|null $modulcode database column
 * @property int $position database column
 * @property I18NString|null $bezeichnung database column
 * @property string $author_id database column
 * @property string $editor_id database column
 * @property int $mkdate database column
 * @property int $chdate database column
 * @property Modul $modul belongs_to Modul
 * @property StgteilAbschnitt $abschnitt belongs_to StgteilAbschnitt
 */

class StgteilabschnittModul extends ModuleManagementModelTreeItem
{
    protected static function configure($config = [])
    {
        $config['db_table'] = 'mvv_stgteilabschnitt_modul';

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

        $config['i18n_fields']['bezeichnung'] = true;

        parent::configure($config);
    }

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

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

    public function getDisplayName()
    {
        if ($this->isNew()) {
            return parent::getDisplayName();
        }
        $template = Config::get()->MVV_TEMPLATE_NAME_STGTEILABSCHNITTMODUL;
        $placeholders = [
            'module_code',
            'module_name',
            'semester_validity'
        ];
        $replacements = [
            trim($this->modulcode) ?: trim($this->modul->code),
           trim($this->bezeichnung) ?: trim($this->modul->getDeskriptor()->bezeichnung),
            $this->modul->getDisplaySemesterValidity()
        ];
        return self::formatDisplayName($template, $placeholders, $replacements);
    }

    /**
     * Retrieves all Modul assignments to the given Studiengangteil-Abschnitt.
     *
     * @param string $abschnitt_id The id of a Studiengangteil-Abschnitt.
     * @param array $filter An array of filter definitions,
     * see ModuleManagementModel::getFilterSql().
     * @return array Array of Modul assignments.
     */
    public static function findByStgteilAbschnitt($abschnitt_id, $filter)
    {
        return parent::findBySQL('INNER JOIN mvv_modul USING(modul_id) '
         . 'LEFT JOIN semester_data start_sem '
         . 'ON (mvv_modul.start = start_sem.semester_id) '
         . 'LEFT JOIN semester_data end_sem '
         . 'ON (mvv_modul.end = end_sem.semester_id) '
         . 'LEFT JOIN mvv_stgteilabschnitt '
         . 'ON (mvv_stgteilabschnitt.abschnitt_id = mvv_stgteilabschnitt_modul.abschnitt_id) '
         . 'LEFT JOIN mvv_stgteilversion '
         . 'ON (mvv_stgteilabschnitt.version_id = mvv_stgteilversion.version_id) '
         . 'WHERE mvv_stgteilabschnitt_modul.abschnitt_id = ? '
         . self::getFilterSql($filter)
         . ' ORDER BY position, mkdate', [$abschnitt_id]);
    }

    /**
     * Returns the assigned Fachsemester. If the given Fachsemester is not
     * assigned, it returns null.
     *
     * @param string $modulteil_id
     * @param string $fachsemester
     * @return null|object
     */
    public function getFachsemester($modulteil_id, $fachsemester)
    {
        return ModulteilStgteilabschnitt::find(
                [$modulteil_id, $this->abschnitt_id, $fachsemester]);
    }

    /**
     * Returns an array of all assigned Fachsemester.
     *
     * @param string $modulteil_id
     * @return array Array of objects of assigned Fachsemester
     */
    public function getAllFachsemester($modulteil_id)
    {
        $ret = [];
        $modulteil_abschnitte = ModulteilStgteilabschnitt::findBySql(
                'modulteil_id = ' . DBManager::get()->quote($modulteil_id)
                . ' AND abschnitt_id = '
                . DBManager::get()->quote($this->abschnitt_id));
        foreach ($modulteil_abschnitte as $modulteil_abschnitt) {
            $ret[$modulteil_abschnitt->fachsemester] = $modulteil_abschnitt;
        }
        return $ret;
    }

    /**
     * @see SimpleORMap::delete();
     */
    public function delete()
    {
        foreach ($this->modul->modulteile as $modulteil) {
            ModulteilStgteilabschnitt::deleteBySql(
                    'modulteil_id = '
                    . DBManager::get()->quote($modulteil->getId())
                    . ' AND abschnitt_id = '
                    . DBManager::get()->quote($this->abschnitt_id));
        }

        return parent::delete();
    }

    /**
     * @see MvvTreeItem::getTrailParentId()
     */
    public function getTrailParentId()
    {
        return $this->abschnitt_id;
    }

    /**
     * @see MvvTreeItem::getTrailParent()
     */
    public function getTrailParent()
    {
        /* Augsburg
        return Abschluss::get($this->getTrailParentId());
         *
         */
        return StgteilAbschnitt::findCached($this->getTrailParentId());
    }

    /**
     * @see MvvTreeItem::getChildren()
     */
    public function getChildren()
    {
        $_SESSION['MVV/StgteilAbschnitt/trail_parent_id'] =  $this->abschnitt_id;
        $_SESSION['MVV/Modulteil/trail_parent_id'] =  $this->modul_id;
        // return Modulteil::findByModul($this->getId());
        $ret = Lvgruppe::getEnrichedByQuery('SELECT ml.* '
                . 'FROM mvv_lvgruppe ml '
                . 'LEFT JOIN mvv_lvgruppe_modulteil USING(lvgruppe_id) '
                . 'LEFT JOIN mvv_modulteil USING(modulteil_id) '
                . 'WHERE modul_id = ? ', [$this->modul_id]);
        return $ret;
    }

    /**
     * @see MvvTreeItem::hasChildren()
     */
    public function hasChildren()
    {
        return count($this->getChildren()) > 0;
    }

    /**
     * @see MvvTreeItem::getParents()
     */
    public function getParents($mode = null)
    {
        return [$this->abschnitt];
    }

     /**
     * Inherits the status of the parent StgteilAbschnitt.
     *
     * @return string the status of parent StgteilAbschnitt
     */
    public function getStatus()
    {
        // workaround to copy module with assignments to Studiengangteil-Version
        // check first whether it is new
        if ($this->isNew()) {
            return $GLOBALS['MVV_STGTEILVERSION']['STATUS']['default'];
        }
        if ($this->abschnitt) {
            return $this->abschnitt->getStatus();
        }
        return parent::getStatus();
    }
}