aboutsummaryrefslogtreecommitdiff
path: root/lib/models/CourseTopic.class.php
blob: adad4d167e976ed13c950923eb90d0d61159d16d (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
<?php
/**
 * 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     Rasmus Fuhse <fuhse@data-quest.de>
 * @copyright   2014 Stud.IP Core-Group
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 *
 * @property string issue_id database column
 * @property string id alias column for issue_id
 * @property string seminar_id database column
 * @property string author_id database column
 * @property string title database column
 * @property string description database column
 * @property string priority database column
 * @property string mkdate database column
 * @property string chdate database column
 * @property DocumentFolder folder belongs_to DocumentFolder
 * @property Course course belongs_to Course
 * @property User author belongs_to User
 * @property SimpleORMapCollection dates has_and_belongs_to_many CourseDate
 */
class CourseTopic extends SimpleORMap
{
    public static function findByTermin_id($termin_id)
    {
        return self::findBySQL("INNER JOIN themen_termine USING (issue_id)
            WHERE themen_termine.termin_id = ?
            ORDER BY priority ASC",
            [$termin_id]
        );
    }

    public static function findBySeminar_id($seminar_id, $order_by = 'ORDER BY priority')
    {
        return parent::findBySeminar_id($seminar_id, $order_by);
    }

    public static function findByTitle($seminar_id, $name)
    {
        return self::findOneBySQL("seminar_id = ? AND title = ?", [$seminar_id, $name]);
    }

    public static function getMaxPriority($seminar_id)
    {
        return DBManager::get()->fetchColumn("SELECT MAX(priority) FROM themen WHERE seminar_id=?", [$seminar_id]);
    }

    protected static function configure($config = [])
    {
        $config['db_table'] = 'themen';
        $config['has_and_belongs_to_many']['dates'] = [
            'class_name' => 'CourseDate',
            'thru_table' => 'themen_termine',
            'order_by'   => 'ORDER BY date',
            'on_delete'  => 'delete',
            'on_store'   => 'store'
        ];
        $config['has_many']['folders'] = [
            'class_name'  => 'Folder',
            'assoc_func' => 'findByTopic_id'
        ];
        $config['belongs_to']['course'] = [
            'class_name'  => 'Course',
            'foreign_key' => 'seminar_id'
        ];
        $config['belongs_to']['author'] = [
            'class_name'  => 'User',
            'foreign_key' => 'author_id'
        ];

        $config['additional_fields']['forum_thread_url']['get'] = 'getForumThreadURL';

        $config['registered_callbacks']['before_create'][] = 'cbDefaultValues';
        $config['registered_callbacks']['after_store'][] = 'cbUpdateConnectedContentModules';
        $config['registered_callbacks']['before_delete'][] = 'cbUnlinkConnectedContentModules';

        parent::configure($config);
    }

    /**
    * set or update connection with document folder
    */
    public function connectWithDocumentFolder()
    {
        if ($this->seminar_id) {
            $document_module = Seminar::getInstance($this->seminar_id)->getSlotModule('documents');
            if ($document_module) {
                if (!$this->folders->count()) {
                    $folder = new Folder();
                    $folder['range_id'] = $this['seminar_id'];
                    $folder['parent_id'] = Folder::findTopFolder($this['seminar_id'])->getId();
                    $folder['range_type'] = "course";
                    $folder['folder_type'] = "CourseTopicFolder";
                    $folder['data_content']['topic_id'] = $this->getId();
                    $folder['user_id'] = $GLOBALS['user']->id;
                    $folder['name'] = $this['title'];
                    $folder['description'] = $this['description'];
                    return $folder->store();
                }
            }
        }
        return false;
    }

    /**
    * set or update connection with forum thread
    */
    public function connectWithForumThread()
    {
        if ($this->seminar_id) {
            $forum_module = Seminar::getInstance($this->seminar_id)->getSlotModule('forum');
            if ($forum_module instanceOf ForumModule) {
                $forum_module->setThreadForIssue($this->id, $this->title, $this->description);
                return true;
            }
        }
        return false;
    }

    public function getForumThreadURL()
    {
        if ($this->seminar_id) {
            $forum_module = Seminar::getInstance($this->seminar_id)->getSlotModule('forum');
            if ($forum_module instanceOf ForumModule) {
                return html_entity_decode($forum_module->getLinkToThread($this->id));
            }
        }
        return '';
    }

    protected function cbUpdateConnectedContentModules()
    {
        if ($this->isFieldDirty('title') || $this->isFieldDirty('description')) {
            if ($this->forum_thread_url) {
                $this->connectWithForumThread();
            }
        }
    }

    /**
     * Removes link information for forum topic and remove forum topic as well
     * if it is empty.
     */
    protected function cbUnlinkConnectedContentModules()
    {
        $query = "DELETE fei, fe
                  FROM `forum_entries_issues` AS fei
                  LEFT JOIN `forum_entries` AS fe
                    ON fei.`topic_id` = fe.`topic_id` AND fe.`rgt` = fe.`lft` + 1
                  WHERE `issue_id` = ?";
        DBManager::get()->execute($query, [$this->id]);
    }

    protected function cbDefaultValues()
    {
        if (empty($this->content['priority'])) {
            $this->content['priority'] = self::getMaxPriority($this->seminar_id) + 1;
        }
    }

    /**
     * return all filerefs belonging to this topic, permissions fpr given user are checked
     *
     * @param string|User $user_or_id
     * @return mixed[] A mixed array with FolderType and FileRef objects.
     */
    public function getAccessibleFolderFiles($user_or_id)
    {
        $user_id = $user_or_id instanceof User ? $user_or_id->id : $user_or_id;
        $all_files = [];
        $all_folders = [];
        $folders = $this->folders->getArrayCopy();
        foreach ($this->dates as $date) {
            $folders = array_merge($folders, $date->folders->getArrayCopy());
        }
        foreach ($folders as $folder) {
            list($files, $typed_folders) = array_values(FileManager::getFolderFilesRecursive($folder->getTypedFolder(), $user_id));
            foreach ($files as $file) {
                $all_files[$file->id] = $file;
            }
            $all_folders = array_merge($all_folders, $typed_folders);
        }
        return ['files' => $all_files, 'folders' => $all_folders];
    }
}