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