aboutsummaryrefslogtreecommitdiff
path: root/lib/filesystem/MVVFolder.php
blob: 2d153dc8090b75337c725f7fc3062314cbf52d15 (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
<?php
/**
 * MVVFolder.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    Timo Hartge <hartge@data-quest.de>
 * @license   http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category  Stud.IP
 * @since     4.4
 */
class MVVFolder extends StandardFolder
{

    public static function availableInRange($range_id_or_object, $user_id)
    {
        return false;
    }

    /**
     * @param string $user_id
     * @return bool
     */
    public function isSubfolderAllowed($user_id)
    {
        return false;
    }

    /**
     * See method MVVFolder::isReadable
     */
    public function isFileDownloadable($file_ref_id, $user_id)
    {
        return $this->isReadable($user_id);
    }

    /**
     * @param string $user_id
     * @return bool
     */
    public function isReadable($user_id)
    {
        return true;
    }

    /**
     * Returns a localised name of the PublicFolder type.
     *
     * @return string The localised name of this folder type.
     */
    static public function getTypeName()
    {
        return _('Ein Ordner für Studiengänge');
    }

    /**
     * Returns a description template for PublicFolders.
     *
     * @return string A string describing this folder type.
     */
    public function getDescriptionTemplate()
    {
        return _('Dateien aus diesem Ordner werden durch den Studiengang zum Download angeboten.');
    }

    /**
     * Retrieves the top folder for a mvv object.
     *
     * @param string $range_id The mvv object-ID of the mvv object whose top folder
     *     shall be returned
     *
     * @return MVVFolder|null The top folder of the mvv object identified by
     *     $range_id. If the folder can't be retrieved, null is returned.
     */
    public static function findTopFolder($range_id)
    {
        //try to find the top folder:
        $folder = Folder::findOneByrange_id($range_id);
        if ($folder) {
            $topfolder = $folder->getTypedFolder();
        }
        return $topfolder ?? null;
    }

    /**
     * Creates a root folder (top folder) for a mvv object referenced by its ID.
     *
     * @param string $range_id The ID of a mvv object for which a root folder
     *     shall be generated.
     *
     * @return MVVFolder A new MVVFolder as root folder for a mvv object.
     */
    public static function createTopFolder($range_id)
    {
        return new MVVFolder(
            Folder::createTopFolder(
                $range_id,
                'mvv',
                'MVVFolder'
            )
        );
    }

}