tag/upgrade.txt

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