XF 2.1 / 2.2 Content Ratings for XF2.1+ 2.4.2

[valaiVerified member]

Description:
Inspired by XF1's "Post Ratings" extension and the prevalence of "Reactions" as an alternative to one-dimensional Likes.

Does not work with XF 2.1

Post Installing
This add-on will require configuration, only a default "Like" is added after installing.

• Tools => Import Data => Import from XF1 Post Ratings
• Content => Content Rating => Rating Types => Add Default Rating Types
  • This adds "Facebook Style" ratings of;
    • Like Like
    • Love
    • Haha
    • Wow
    • Sad ?
    • Angry
• Content => Content Rating => Rating Types =>Add New Rating Type.

Installing/Uninstalling on a large forum

It is strongly recommended to use the CLI installer/uninstaller.

Spoiler: For large forum

This add-on alters xf_like_content, which can take a very long time for a large forum.

To run the SQL manually, use;

alter table xf_like_content
    add column sv_rating_type_id unsigned int DEFAULT NULL,
    add index like_user_id_like_date ('like_user_id','like_date');

On uninstalling non-like ratings are dropped;

DELETE  FROM `xf_liked_content` WHERE sv_rating_type_id IS NOT NULL AND sv_rating_type_id <> 0

This is very slow.

To disable this behaviour, find uninstallStep3 in this add-on's Setup.php and comment out/remove the content of the function.

Features

• XF1 "Post Ratings" importer
• Whitelist/blacklist ratings by user group, lock to starting poster, and limit to forums (for threads)
• Content Ratings/Reactions on Posts and Conversations.
  • Integrates with alerts & news feed where applicable.
• Rating Types;
  • Support flexible image icon selection;
    • Emoji
    • Sprite Images
    • Images (with high definition alternative image)
    • css fonts
    • Templates (for inline SVG)
  • A Rating type can be usable or visible;
    • Visible & usable - everyone can use and see
    • Not visible & usable - only the person giving the rating can see their own rating, allowing a "private rating".
    • Visible & not usable - everyone can see, not may not use it.
    • Not Visible & not usable, - no one may see or use it.
• Supported Content types:
  • Posts
  • Conversation Messages
  • Profile Posts
  • Profile Post Comments
• Rating Categories
  • For example; positive/negative/neutral categories
  • If a category shows on the profile/memberbit/postbit & how stats are presented.
• Statistics integration
• User Criteria integration
• Selectable "default rating" to display as the menu icon, can be Random, or None.
• Large number of style properties to customize look and feel.
  • Horizontal rating selection
  • Touch support
• Display highest ratings on thread rating list (disabled by default)
  • Global option to enable/disable
  • Style property options to customize
• Rating Categories automatic actions when a category hits some threshold ;
  • Report content
  • Moderate content
  • Soft-delete content
• Allow arbitrary number of rating type/rating type category user criteria

Implementation notes

• Designed for performance, only minimal data is fetched when interacting with the rating system
  • Overrides XF2's rebuild behaviour to instead be incremental rather than count all ratings on a piece of content.
• As MySQL's InnoDB table structure does not feature prefix compression, a content type/id pair is very inefficient space-wise.
• Uses per-content tables which are dynamically managed to store count totals, and automagically links these to the right places for use.
• If a content's table is "too large" to extend (ie when adding a rating type) without downtime, that content has the rating type disabled for it and the required manual SQL for the administrator to run provided.
  • "too large " table size threshold is an adjustable, may be to fully automatic or fully manual for adding columns.

Style Property screenshots
This add-on has a large number of style property customization options, and the following screenshots demo some of the options:

Download V2.0.7 :
https://mega.nz/file/8x5UGRqa#vNMQY5KycubWjjOramNnzpBYwt8P-QrMZg9dPYkrG2k

Version 2.1.0 changes :
Reduce deadlocking when updating user records by ensuring a consistently ordering is used when applying updates
Fix removing reactions did not show, and rework UI to be saner
Respect 'small' and 'medium' sizes in relevant places in the UI
Emoji/Text reactions font-sizes are now style-property controlled instead of picking up the ambient size.
Download V2.1.0 :
https://mega.nz/file/UhwykZqJ#N-Q0J8MxjpQ5h-fgJuJQjOwuLMG7IjJ8Vi3NM3Fn_vM

Version 2.1.2 - Bugfix update :
Workaround for older browsers which can't handle inline-flex
Fix deleting reaction on XFMG/XFRM which triggers template warnings
Fix thread first post's reactions linking from thread list
Fix emoji reaction sizing issues
Fix that the style properties "Reaction"/"Reaction icon"/"Reaction icon container"/"Reaction text" where not applying
Download V2.1.2 :
https://mega.nz/file/IkwyELZQ#QIIIJIMDH4U1jgtjDD48TRVmBeG0nBMPwWASdAuEEZk

Version 2.1.3 - bugfix :
When extended non-core content types, fix incorrect css being applied in fallback case resulting in sprite-based reaction icons not displaying as expected
Download V2.1.3 :
https://mega.nz/file/R5I2WCwK#PcJW0q9GvquG6Kaz7bMgKY-azb-r8ZvUlj1l1k4Mbgo

Version 2.1.4 change :
Remove legacy XF2.0 support for XenPorta2
Allow importing multiple Post Ratings to an existing XenForo reaction definition

Version 2.1.5 change :
Patch around XF behaviour which causes exessive recomputing of user's reaction scores
Improve compatibility with non-extended content types
Fix javascript error "TypeError: Cannot read property 'content' of undefined" with some non-extended content types

Version 2.1.6 change : Fix enabled but empty white-list for reaction restrictions to work as intended
Download V2.1.6 :
https://mega.nz/file/U5piWLhI#vz2B-NYstmzWwVRCtdnjO0E64iMxjXzsXDssEl-BDYw

Version 2.1.7 : Work-around for an error detecting MySQL json support on install
Version 2.1.8 : Fix support for links to content with a query argument in them (ie support "Content Ratings - Reports")
Version 2.1.9 : Prevent reactions which are not visible showing in the news feed

Version 2.2.0 - XF2.2 compatibility :
Requires php 7.0+
Now depends on Standard Library by Xon
Supports XF2.2

Version 2.2.1 : Fix "Display reaction titles alongside icons" style property being ignored
Version 2.2.2 : Actually implement "Display 'remove' instead of XF reaction title+color" style property

Version 2.2.3 - Maintenance :
Compatibility update when resolving an extended class to the root class
Require Standard Library by Xon v1.2.0+

Version 2.2.4 - Bugfix update :
Require Standard Library by Xon v1.2.1+
Fix possible MySQL 8.0+ compatibility issue when upgrading
Download V2.2.4 :
https://mega.nz/file/R0QXQQxK#LcTd35-PmWwyYiQMswIuq9566v_JLVSc1kA9t0Dbkow

Version 2.2.5 - Style update : Fix inline reaction bar & in-place of XF react button consuming more space than expected for the list of reactions
Download V2.2.5 :
https://mega.nz/file/YpYUkSbT#1PrW5lc-7N3nKc_4G5qtVLAvJCEgDJk3cmkZBkYBb2Q

Version 2.2.6 Compatibility update : Fix MySQL 8+ compatibility when uninstalling

Version 2.2.7 Compatibility update : Fix UI.X compatibility issue on importing styles

Version 2.2.8 Compatibility update : XF2.2 compatibility fix with stats block not being extended as expected

Version 2.2.9 Bugfix update :
Fix reaction list for visible but not usable reactions not displaying
Fix that reacting to content with a visible but not usable reaction removes the non-usable reaction from displaying on the content
Download V2.2.9 :
https://mega.nz/file/xsRRHK4Y#hR58sbKtRry1h9JOVrFeP1i5ubD7nnZ1783iKzpcVQs

Version 2.2.10 - Maintenance & minor feature update :
Fix that "small" and "medium" reaction icon css was not implemented (ie reactions in alerts)
To revert, edit sv_contentratings.less in your default style and remove the &.sv-rating-type--small { ... } and &.sv-rating-type--medium { ... } blocks
Fix "XF template" feature did not save a value
Support Svg Template add-on (free) in "XF Template" feature.
Entering a template name ending in 'svg' (ie example.svg) will render as a link instead as an inline template
Download V2.2.10 :
https://mega.nz/file/YxBUFYRY#-RDhtOdH9ARFSVQ8gn3qVwUWlgcvLC4C4YUr2EpkscE

Version 2.3.0 - Feature update :
Force global namespace for functions which are known to be optimizable to bytecode in php
Support storing height/width for non-sprite images, as to avoid page reflows and improve Core Web Vitals
Helper method fetches the public reaction images and extracts height/width as required
If using Svg Template, recommend Svg Template v2.3.2+
Download V2.3.0 :
https://mega.nz/file/1oZVhI5K#ZXbaZutn4GyR2wGOLwleOFQPq949gRk38puxwV2VUSY

Version 2.3.1 - Maintenance update : When attempting to update image dimensions for Core Web Vitals, improve extracting svg dimensions.
Download V2.3.1 :
https://mega.nz/file/U5YknK5b#vws0P7yG_Gcr9_Hw-1_8tQEGgSEWHOB45hA8rK8Ibvk

Version 2.3.2 - Bugfix update :
Work-around for 3rd party reaction implementations which are not structured as expected
On rebuilding reaction data, this add-on skips reaction_class_handler entities which do not have a linked entity entity
Download V2.3.2 :
https://mega.nz/file/1kASQZJa#OdIMK_Uv-QVVAj18wcUJtASEQf6x1NMM8Jnzl0q-w64

Spoiler: Changelog

Version 2.3.3 : Fix support for content types which implement the "Like" handler instead of "Reaction" handler

Version 2.3.4 : Fix server error when attempting to extract svg dimensions when using SVG templates.

Version 2.3.5 :

- Fix inactive but visible reactions not displaying in the reaction list or as being given correctly. Requires content to be reacted to to update caches
- Rename various whitelist/blacklist phrases to allow/deny terminology
- Fix "allow by content type" restriction did now show human-readable content type name
- Add "deny by content type" restriction

Version 2.4.0 :

Note; The 2.4.x branch will be the last version line to support XenForo 2.1, with future feature updates requiring XenForo 2.2+

- Fix incorrect visibility change of some extended reaction entity methods
- Do not trigger style cache invalidation when editing reaction categories or reactions which do not touch attributes used in css.
- Remove duplicate breadcrumb entry when editing a reaction
- Add date range criteria to restrictions, with filter to exclude/include reactions which are disabled by scheduled start/stop

Version 2.4.1 : When rebuilding reaction totals, skip content types which do not correctly define the entity content_type_field according to XF conventions.

Version 2.4.2 : Initial php 8.2 compatibility update.
Download V2.4.2 :
https://mega.nz/file/hpYRRDrJ#3Lh85KSjPq6hi8oaAENkRbmlpN5V8qTKpKiSgUJU_9Y

 

XF 2.2 / 2.3  AndyB Country flag select 1.5

XF 2.0 / 2.1 / 2.2  [DBTech] DragonByte User Tagging 1.7.6