lib.php 5.34 KB
Newer Older
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
<?php
/**
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @package    mahara
 * @subpackage blocktype-inbox
 * @author     Catalyst IT Ltd
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
 *
 */

defined('INTERNAL') || die();

class PluginBlocktypeInbox extends SystemBlocktype {

    public static function get_title() {
        return get_string('title', 'blocktype.inbox');
    }

    public static function get_description() {
        return get_string('description', 'blocktype.inbox');
    }

    public static function get_categories() {
        return array('general');
    }

    public static function get_viewtypes() {
        return array('dashboard');
    }

    public static function render_instance(BlockInstance $instance, $editing=false) {
        global $USER;
        $configdata = $instance->get('configdata');

        $desiredtypes = array();
53
54
55
56
        foreach($configdata as $k => $v) {
            if (!empty($v) && $k != 'maxitems') {
                $type = preg_replace('/[^a-z]+/', '', $k);
                $desiredtypes[$type] = $type;
57
58
            }
        }
59
60
61
62

        if ($USER->get('admin') && !empty($desiredtypes['adminmessages'])) {
            unset($desiredtypes['adminmessages']);
            $desiredtypes += get_column('activity_type', 'name', 'admin', 1);
63
64
        }

65
        $maxitems = $configdata['maxitems'] ? $configdata['maxitems'] : 5;
66
67
68

        $records = array();
        if ($desiredtypes) {
69
            $sql = "
70
                SELECT n.id, n.subject, n.message, n.url, n.urltext, n.read, t.name AS type
71
72
73
74
75
76
                FROM {notification_internal_activity} n JOIN {activity_type} t ON n.type = t.id
                WHERE n.usr = ?
                AND t.name IN (" . join(',', array_map('db_quote', $desiredtypes)) . ")
                ORDER BY n.ctime DESC
                LIMIT ?;";

77
78
            $records = get_records_sql_array($sql, array(
                $USER->get('id'),
79
                $maxitems + 1 // Hack to decide whether to show the More... link
80
81
82
            ));
        }

83
84
85
86
87
        // Hack to decide whether to show the More... link
        if ($showmore = count($records) > $maxitems) {
            unset($records[$maxitems]);
        }

88
89
90
91
92
93
94
        if ($records) {
            require_once('activity.php');
            foreach ($records as &$r) {
                $r->message = format_notification_whitespace($r->message);
            }
        }

95
        $smarty = smarty_core();
96
97
98
        if ($showmore) {
            $smarty->assign('desiredtypes', implode(',', $desiredtypes));
        }
99
100
        $smarty->assign('blockid', 'blockinstance_' . $instance->get('id'));
        $smarty->assign('items', $records);
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
        return $smarty->fetch('blocktype:inbox:inbox.tpl');
    }

    public static function has_instance_config() {
        return true;
    }

    public static function instance_config_form($instance) {
        global $USER;
        $configdata = $instance->get('configdata');

        $types = get_records_array('activity_type', 'admin', 0, 'plugintype,pluginname,name', 'name,plugintype,pluginname');
        if ($USER->get('admin')) {
            $types[] = (object)array('name' => 'adminmessages');
        }

        $elements = array();
        $elements['types'] = array(
            'type' => 'fieldset',
            'legend' => get_string('messagetypes', 'blocktype.inbox'),
            'elements' => array(),
        );
        foreach($types as $type) {
            if (!empty($type->plugintype)) {
                $title = get_string('type' . $type->name, $type->plugintype . '.' . $type->pluginname);
            }
            else {
                $title = get_string('type' . $type->name, 'activity');
            }
            $elements['types']['elements'][$type->name] = array(
                'type' => 'checkbox',
                'title' => $title,
133
                'defaultvalue' => isset($configdata[$type->name]) ? $configdata[$type->name] : 0,
134
135
136
137
138
139
            );
        }
        $elements['maxitems'] = array(
            'type' => 'text',
            'title' => get_string('maxitems', 'blocktype.inbox'),
            'description' => get_string('maxitemsdescription', 'blocktype.inbox'),
140
            'defaultvalue' => isset($configdata['maxitems']) ? $configdata['maxitems'] : 5,
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
        );

        return $elements;
    }

    public static function default_copy_type() {
        return 'shallow';
    }

    /**
     * Inbox only makes sense for personal views
     */
    public static function allowed_in_view(View $view) {
        return $view->get('owner') != null;
    }
}

?>