Merge branch 'MDL-83085-main' of https://github.com/meirzamoodle/moodle
[moodle.git] / tag / upgrade.txt
blob73681f633a883f4201605c0451da062fc44858af
1 === 4.5 Onwards ===
3 This file has been replaced by UPGRADING.md. See MDL-81125 for further information.
5 ===
6 This files describes API changes in tagging, information provided
7 here is intended especially for developers.
9 === 4.4 ===
11 * New additional property 'viewurl' has been added to the pre-defined structure in tag_item_exporter. This property
12   represents the URL to view a given tag.
13 * The `core_tag_manage_table` class has been deprecated, in favour of new report builder implementation
15 === 3.6 ===
17 * The following functions have been finally deprecated and can not be used anymore:
18   * tag_type_set()
19   * tag_description_set()
20   * tag_get_tags()
21   * tag_get_tags_array()
22   * tag_get_tags_csv()
23   * tag_get_tags_ids()
24   * tag_get_id()
25   * tag_rename()
26   * tag_delete_instance()
27   * tag_add()
28   * tag_assign()
29   * tag_record_count()
30   * tag_record_tagged_with()
31   * tag_set_flag()
32   * tag_unset_flag()
33   * tag_print_cloud()
34   * tag_print_description_box()
35   * tag_print_management_box()
36   * tag_print_search_box()
37   * tag_print_search_results()
38   * tag_print_tagged_users_table()
39   * tag_print_user_box()
40   * tag_print_user_list()
41   * tag_display_name
42   * tag_normalize
43   * tag_get_related_tags_csv()
44   * tag_set()
45   * tag_set_add()
46   * tag_set_delete()
47   * tag_get()
48   * tag_get_related_tags()
49   * tag_delete
50   * tag_delete_instances()
51   * tag_cleanup()
52   * tag_bulk_delete_instances()
53   * tag_compute_correlations()
54   * tag_process_computed_correlation()
55   * tag_cron()
56   * tag_find_tags()
57   * tag_get_name()
58   * tag_get_correlated()
59   * tag_cloud_sort()
61 === 3.1 ===
63 * Each plugin must define the tag areas it uses in plugindir/db/tag.php
64   See https://moodledev.io/docs/apis/subsystems/tag/ for more details.
65 * When adding a 'tags' form element the component and itemtype must be specified
66   in the element attributes.
67 * Tag name is no longer a unique field in 'tag' table, tags may be separated in
68   tag collections
69 * Specifying component is also required when retrieving item tags. This will allow
70   different components to add tags to the same table (for example blog and forum
71   posts) and even suggest alternative tagging for the same items.
72 * All tag_* functions were deprecated because they now require either tag
73   collection id or component, some were moved to the new class core_tag_tag and
74   some - to the renderers or templates. As usual, the deprecated function code
75   and debugging message will provide you with the suggestions of the alternative.
76   Please note that all deprecated functions will be removed after several major releases.
77   - tag_type_set
78   - tag_description_set
79   - tag_get_tags
80   - tag_get_tags_array
81   - tag_get_tags_csv
82   - tag_get_tags_ids
83   - tag_get_id
84   - tag_rename
85   - tag_delete_instance
86   - tag_find_records
87   - tag_add
88   - tag_assign
89   - tag_record_count
90   - tag_record_tagged_with
91   - tag_set_flag
92   - tag_unset_flag
93   - tag_print_cloud
94   - tag_print_description_box
95   - tag_print_management_box
96   - tag_print_search_box
97   - tag_print_search_results
98   - tag_print_tagged_users_table
99   - tag_print_user_box
100   - tag_print_user_list
101   - tag_display_name
102   - tag_normalize
103   - tag_get_related_tags_csv
104   - tag_set
105   - tag_set_add
106   - tag_set_delete
107   - tag_get
108   - tag_get_related_tags
109   - tag_delete
110   - tag_delete_instances
111   - tag_cleanup
112   - tag_bulk_delete_instances
113   - tag_compute_correlations
114   - tag_process_computed_correlation
115   - tag_cron
116   - tag_find_tags
117   - tag_get_name
118   - tag_get_correlated
119   - tag_cloud_sort
120 * Char field 'tagtype' in database table 'tag' is replaced with int (0 or 1) field 'isstandard'.
122 === 3.0 ===
124 * Tagging courses is now implemented without user id - through course edit form or
125   special "Course tags" form. All coursetag_* functions in /tag/coursetagslib.php
126   were deprecated without replacement and related JS code was removed. Config variable
127   $CFG->block_tags_showcoursetags was removed.
129 === 2.7 ===
131 * The functions tag_set, tag_set_add, tag_set_delete and tag_assign now expect the component
132 and contextid of the item being tagged.
134 === 2.6 ===
136 More cleanup was done to tag cloud sorting which involved some API changes, see MDL_39800
137 * tag_print_cloud() arguments were changed.
138 * coursetag_get_tags() arguments were changed.
139 * coursetag_get_all_tags() arguments were changed.
140 * coursetag_sort() was removed.
142 === 2.4 ===
144 Significant cleanup was done to course tags which involved some API
145 changes, see MDL-15471
146 * tag_print_cloud() arguments were changed
147 * coursetag_print_cloud() was removed.
148 * coursetag_get_official_keywords() was removed
149 * coursetag_rss_feeds() was removed