tag/upgrade.txt

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