aboutsummaryrefslogtreecommitdiff
path: root/lib/models/Courseware/Bookmark.php
blob: 0cd4c59ac6b898c500bbd84896b2f8e1facb0d9f (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
<?php

namespace Courseware;

/**
 * Courseware's bookmarks.
 *
 * @author  Marcus Eibrink-Lunzenauer <lunzenauer@elan-ev.de>
 * @author  Till Glöggler <gloeggler@elan-ev.de>
 * @author  Ron Lucke <lucke@elan-ev.de>
 * @license GPL2 or any later version
 *
 * @since   Stud.IP 5.0
 *
 * @property array $id alias for pk
 * @property string $user_id database column
 * @property int $element_id database column
 * @property int $mkdate database column
 * @property int $chdate database column
 * @property \User $user belongs_to \User
 * @property StructuralElement $element belongs_to StructuralElement
 */
class Bookmark extends \SimpleORMap implements \PrivacyObject
{
    protected static function configure($config = [])
    {
        $config['db_table'] = 'cw_bookmarks';

        $config['belongs_to']['user'] = [
            'class_name' => \User::class,
            'foreign_key' => 'user_id',
        ];

        $config['belongs_to']['element'] = [
            'class_name' => StructuralElement::class,
            'foreign_key' => 'element_id',
        ];

        parent::configure($config);
    }

    /**
     * Returns the range object this bookmark belongs to.
     *
     * @return \Range the range object of this object
     */
    public function getRange(): \Range
    {
        $rangeType = $this->element['range_type'];

        return $this->element->$rangeType;
    }

    /**
     * Returns all bookmarks of a user.
     *
     * @param \User $user the user for whom to search for bookmarks
     *
     * @return Bookmark[] the list of bookmarks
     */
    public static function findUsersBookmarks($user): array
    {
        return self::findBySQL('user_id = ? ORDER BY chdate', [$user->id]);
    }

    /**
     * Export available data of a given user into a storage object
     * (an instance of the StoredUserData class) for that user.
     *
     * @param StoredUserData $storage object to store data into
     */
    public static function exportUserData(\StoredUserData $storage)
    {
        $bookmarks = \DBManager::get()->fetchAll(
            'SELECT * FROM cw_bookmarks WHERE user_id = ?',
            [$storage->user_id]
        );
        if ($bookmarks) {
            $storage->addTabularData(_('Courseware Lesezeichen'), 'cw_bookmarks', $bookmarks);
        }
    }
}