aboutsummaryrefslogtreecommitdiff
path: root/classes/managertokens_table.php
blob: 6c77b8ed940bba5c98b37e60af0b7bfe6844a0ec (plain) (blame)
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
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle 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 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Describes the plugin tables.
 *
 * @package   tool_managertokens
 * @copyright 2017 "Valentin Popov" <info@valentineus.link>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined("MOODLE_INTERNAL") || die();

require_once($CFG->libdir . "/tablelib.php");

/**
 * Describes the main table of the plugin.
 *
 * @copyright 2017 "Valentin Popov" <info@valentineus.link>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class tool_managertokens_table extends table_sql {
    /**
     * Manager address.
     *
     * @var string $managertokens
     */
    protected static $managertokens = "/admin/tool/managertokens/index.php";

    /**
     * Editor's address.
     *
     * @var string $editor
     */
    protected static $editor = "/admin/tool/managertokens/editor.php";

    /**
     * Constructor.
     *
     * @param string $uniqueid The unique identifier of the table.
     */
    public function __construct($uniqueid) {
        parent::__construct($uniqueid);
        $this->define_table_columns();
        $this->define_table_configs();
    }

    /**
     * Defines the basic settings of the table.
     */
    public function define_table_configs() {
        $this->set_sql("*", "{tool_managertokens_tokens}", "1");
        $this->collapsible(false);
        $this->is_downloadable(false);
        $this->no_sorting("actions");
        $this->pageable(true);
    }

    /**
     * Defines the main columns and table headers.
     */
    public function define_table_columns() {
        $columns = array(
            "targetid",
            "token",
            "scope",
            "timelastuse",
            "timecreated",
            "actions"
        );

        $headers = array(
            new lang_string("role", "moodle"),
            new lang_string("password", "moodle"),
            new lang_string("used", "moodle"),
            new lang_string("lastmodified", "moodle"),
            new lang_string("create", "moodle"),
            new lang_string("actions", "moodle")
        );

        $this->define_columns($columns);
        $this->define_headers($headers);
    }

    /**
     * Specifies the display of a column with actions.
     *
     * @param  object $row Data from the database.
     * @return string      Displayed data.
     */
    public function col_actions($row) {
        global $OUTPUT;

        /* Sets the switch icon */
        $hideshowicon   = "t/lock";
        $hideshowstring = new lang_string("enable", "moodle");
        if (boolval($row->enabled)) {
            $hideshowicon   = "t/unlock";
            $hideshowstring = new lang_string("disable", "moodle");
        }

        /* Link to enable / disable the token */
        $hideshowlink = new moodle_url(self::$managertokens, array("hideshowid" => $row->id, "sesskey" => sesskey()));
        $hideshowitem = $OUTPUT->action_icon($hideshowlink, new pix_icon($hideshowicon, $hideshowstring));

        /* Link to edit the token */
        $editlink = new moodle_url(self::$editor, array("tokenid" => $row->id));
        $edititem = $OUTPUT->action_icon($editlink, new pix_icon("t/edit", new lang_string("edit", "moodle")));

        /* Link to delete the token */
        $deletelink = new moodle_url(self::$managertokens, array("deleteid" => $row->id, "sesskey" => sesskey()));
        $deleteitem = $OUTPUT->action_icon($deletelink, new pix_icon("t/delete", new lang_string("delete", "moodle")));

        $html = $hideshowitem . $edititem . $deleteitem;
        return $html;
    }

    /**
     * Specifies the display of the column with the role.
     *
     * @param  object $row Data from the database.
     * @return string      Displayed data.
     */
    public function col_targetid($row) {
        $html = $row->targetid;

        /* The role is absent */
        if ($row->targettype == "null") {
            $html = new lang_string("none", "moodle");
        }

        /* A role is a user */
        if ($row->targettype == "user") {
            /* Specifies the user name */
            $linktext = new lang_string("user", "moodle");
            if ($user = core_user::get_user($row->targetid)) {
                $linktext = "$user->firstname $user->lastname";
            }

            /* Creates a reference */
            $linkurl = new moodle_url("/user/profile.php", array("id" => $row->targetid));
            $html = html_writer::link($linkurl, $linktext);
        }

        return $html;
    }

    /**
     * Specifies the display of a column from the time of creation.
     *
     * @param  object $row Data from the database.
     * @return string      Displayed data.
     */
    public function col_timecreated($row) {
        $date = userdate($row->timecreated, new lang_string("strftimerecent", "langconfig"));
        return $date;
    }

    /**
     * Specifies the display of the last used column.
     *
     * @param  object $row Data from the database.
     * @return string      Displayed data.
     */
    public function col_timelastuse($row) {
        $date = $row->timelastuse;

        if (!empty($row->timelastuse)) {
            $date = userdate($row->timelastuse, new lang_string("strftimerecent", "langconfig"));
        }

        return $date;
    }

    /**
     * Specifies the display of a column with a token.
     *
     * @param  object $row Data from the database.
     * @return string      Displayed data.
     */
    public function col_token($row) {
        $linktext = $row->token;
        $linkurl  = new moodle_url(self::$editor, array("tokenid" => $row->id));

        $html = html_writer::link($linkurl, $linktext);
        return $html;
    }
}