tag/upgrade.txt

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