lib.php 7.58 KB
Newer Older
1
2
3
4
5
<?php
/**
 *
 * @package    mahara
 * @subpackage blocktype-resumefield
6
 * @author     Catalyst IT Ltd
7
8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
9
10
11
12
13
 *
 */

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

14
class PluginBlocktypeResumefield extends MaharaCoreBlocktype {
15
16
17
18
19
20
21
22
23
24

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

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

    public static function get_categories() {
25
        return array('internal' => 30000);
26
27
    }

28
29
30
31
32
    public static function get_blocktype_type_content_types() {
        return array('resumefield' => array('resume'));
    }

    /**
33
34
35
36
37
38
39
     * Optional method. If exists, allows this class to decide the title for
     * all blockinstances of this type
     */
    public static function get_instance_title(BlockInstance $bi) {
        $configdata = $bi->get('configdata');

        if (!empty($configdata['artefactid'])) {
40
            return $bi->get_artefact_instance($configdata['artefactid'])->get('title');
41
42
43
44
        }
        return '';
    }

45
    public static function render_instance(BlockInstance $instance, $editing=false) {
46
        require_once(get_config('docroot') . 'artefact/lib.php');
47
48
        $smarty = smarty_core();
        $configdata = $instance->get('configdata');
49
        $configdata['viewid'] = $instance->get('view');
50
51
52

        // Get data about the resume field in this blockinstance
        if (!empty($configdata['artefactid'])) {
53
            $resumefield = $instance->get_artefact_instance($configdata['artefactid']);
54
            $rendered = $resumefield->render_self($configdata);
55
56
            $result = $rendered['html'];
            if (!empty($rendered['javascript'])) {
57
                $result .= '<script type="application/javascript">' . $rendered['javascript'] . '</script>';
58
            }
59
60
            $smarty->assign('content', $result);
            return $smarty->fetch('blocktype:resumefield:content.tpl');;
61
62
63
64
65
66
67
68
        }
        return '';
    }

    public static function has_instance_config() {
        return true;
    }

Son Nguyen's avatar
Son Nguyen committed
69
    public static function instance_config_form(BlockInstance $instance) {
70
71
72
73
74
        $configdata = $instance->get('configdata');

        $form = array();

        // Which resume field does the user want
75
        $form[] = self::artefactchooser_element((isset($configdata['artefactid'])) ? $configdata['artefactid'] : null);
76
        $form['message'] = array(
77
            'type' => 'html',
78
            'value' => '<p class="alert alert-info">' . get_string('filloutyourresume', 'blocktype.resume/resumefield', '<a href="' . get_config('wwwroot') . 'artefact/resume/index.php">', '</a>') .'</p>',
79
        );
80
81
82
83
84
85
86
        $form['tags'] = array(
            'type'         => 'tags',
            'title'        => get_string('tags'),
            'description'  => get_string('tagsdescblock'),
            'defaultvalue' => $instance->get('tags'),
            'help'         => false,
        );
87
88
89
        return $form;
    }

90
91
92
93
94
    public static function instance_config_save($values) {
        unset($values['message']);
        return $values;
    }

95
    // TODO: make decision on whether this should be abstract or not
96
    public static function artefactchooser_element($default=null) {
97
98
99
100
101
102
103
104
105
        safe_require('artefact', 'resume');
        return array(
            'name'  => 'artefactid',
            'type'  => 'artefactchooser',
            'title' => get_string('fieldtoshow', 'blocktype.resume/resumefield'),
            'defaultvalue' => $default,
            'blocktype' => 'resumefield',
            'limit'     => 655360, // 640K profile fields is enough for anyone!
            'selectone' => true,
106
            'search'    => false,
107
108
109
110
111
112
            'artefacttypes' => PluginArtefactResume::get_artefact_types(),
            'template'  => 'artefact:resume:artefactchooser-element.tpl',
        );
    }

    /**
Aaron Wells's avatar
Aaron Wells committed
113
114
     * Deliberately enforce _no_ sort order. The database will return them in
     * the order they were inserted, which means roughly the order that they
115
116
117
118
119
     * are listed in the profile screen
     */
    public static function artefactchooser_get_sort_order() {
        return '';
    }
Richard Mansfield's avatar
Richard Mansfield committed
120

121
    public static function rewrite_resume_config(View $view, $configdata) {
122
        $artefactid = null;
123
        if ($view->get('owner') !== null) {
124
            $artefacttype = null;
125
126
127
128
129
130
131
132
133
134
135
136
            if (!empty($configdata['artefactid'])) {
                $artefacttype = get_field('artefact', 'artefacttype', 'id', $configdata['artefactid']);
            }
            // @todo get artefacttype from a different field when copying from institution or group view.
            if ($artefacttype) {
                $artefactid = get_field('artefact', 'id', 'artefacttype', $artefacttype, 'owner', $ownerid);
            }
        }
        $configdata['artefactid'] = $artefactid;
        return $configdata;
    }

137
138
139
140
    public static function default_copy_type() {
        return 'shallow';
    }

141
    /**
Aaron Wells's avatar
Aaron Wells committed
142
     * Resumefield blocktype is only allowed in personal views, because
143
144
145
146
147
148
     * there's no such thing as group/site resumes
     */
    public static function allowed_in_view(View $view) {
        return $view->get('owner') != null;
    }

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
    /**
     * Export the name of the resume field being exported instead of a
     * reference to the artefact ID - mainly so that the fake "contact
     * information" field (which isn't exported) gets handled properly.
     *
     * @param BlockInstance $bi The blockinstance to export the config for.
     * @return array The config for the blockinstance
     */
    public static function export_blockinstance_config_leap(BlockInstance $bi) {
        $configdata = $bi->get('configdata');
        $result = array();

        if (!empty($configdata['artefactid'])) {
            if ($artefacttype = get_field('artefact', 'artefacttype', 'id', $configdata['artefactid'])) {
                $result['artefacttype'] = json_encode(array($artefacttype));
            }
        }

        return $result;
    }

    /**
     * Load the artefact ID for the field based on the field name that is in
     * the config (see export_blockinstance_config_leap).
     *
     * @param array $biconfig   The block instance config
     * @param array $viewconfig The view config
     * @return BlockInstance The newly made block instance
     */
    public static function import_create_blockinstance_leap(array $biconfig, array $viewconfig) {
        $configdata = array();

        // This blocktype is only allowed in personal views
        if (empty($viewconfig['owner'])) {
            return;
        }
        $owner = $viewconfig['owner'];

        if (isset($biconfig['config']) && is_array($biconfig['config'])) {
            $impcfg = $biconfig['config'];
            if (!empty($impcfg['artefacttype'])) {
                if ($artefactid = get_field_sql("SELECT id
                    FROM {artefact}
Francois Marier's avatar
Francois Marier committed
192
                    WHERE \"owner\" = ?
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
                    AND artefacttype = ?
                    AND artefacttype IN (
                        SELECT name
                        FROM {artefact_installed_type}
                        WHERE plugin = 'resume'
                    )", array($owner, $impcfg['artefacttype']))) {
                    $configdata['artefactid'] = $artefactid;
                }
            }
        }

        $bi = new BlockInstance(0,
            array(
                'blocktype'  => $biconfig['type'],
                'configdata' => $configdata,
            )
        );

        return $bi;
    }

214
}