MDL-51283 core_tag: change tagtype to isstandard
[moodle.git] / lib / db / tag.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Tag area definitions
19  *
20  * File db/tag.php lists all available tag areas in core or a plugin.
21  *
22  * Each tag area may have the following attributes:
23  *   - itemtype (required) - what is tagged. Must be name of the existing DB table
24  *   - component - component responsible for tagging, if the tag area is inside a
25  *     plugin the component must be the full frankenstyle name of the plugin
26  *   - collection - name of the custom tag collection that will be used to store
27  *     tags in this area. If specified aministrator will be able to neither add
28  *     any other tag areas to this collection nor move this tag area elsewhere
29  *   - searchable (only if collection is specified) - wether the tag collection
30  *     should be searchable on /tag/search.php
31  *   - customurl (only if collection is specified) - custom url to use instead of
32  *     /tag/search.php to display information about one tag
33  *   - callback - name of the function that returns items tagged with this tag,
34  *     see core_tag_tag::get_tag_index() and existing callbacks for more details,
35  *     callback should return instance of core_tag\output\tagindex
36  *   - callbackfile - file where callback is located (if not an autoloaded location)
37  *
38  * Language file must contain the human-readable names of the tag areas and
39  * collections (either in plugin language file or in component language file or
40  * lang/en/tag.php in case of core):
41  * - for item type "user":
42  *     $string['tagarea_user'] = 'Users';
43  * - for tag collection "mycollection":
44  *     $string['tagcollection_mycollection'] = 'My tag collection';
45  *
46  * @package   core
47  * @copyright 2015 Marina Glancy
48  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  */
51 defined('MOODLE_INTERNAL') || die();
53 $tagareas = array(
54     array(
55         'itemtype' => 'user', // Users.
56         'component' => 'core',
57         'callback' => 'user_get_tagged_users',
58         'callbackfile' => '/user/lib.php',
59     ),
60     array(
61         'itemtype' => 'course', // Courses.
62         'component' => 'core',
63         'callback' => 'course_get_tagged_courses',
64         'callbackfile' => '/course/lib.php',
65     ),
66     array(
67         'itemtype' => 'question', // Questions.
68         'component' => 'core_question',
69     ),
70     array(
71         'itemtype' => 'post', // Blog posts.
72         'component' => 'core',
73         'callback' => 'blog_get_tagged_posts',
74         'callbackfile' => '/blog/lib.php',
75     ),
76     array(
77         'itemtype' => 'blog_external', // External blogs.
78         'component' => 'core',
79     ),
80 );