Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/rating/classes/phpunit/ -> privacy_helper.php (source)

[Source view]

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

Helpers for the core_rating subsystem implementation of privacy.

Copyright: 2018 Andrew Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 135 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 4 functions

  get_ratings_on_subcontext()
  assert_all_own_ratings_on_context()
  assert_all_ratings_on_context()
  assert_rating_matches()

Functions
Functions that are not part of a class:

get_ratings_on_subcontext(\context $context, array $subcontext)   X-Ref
Fetch all ratings on a subcontext.

param: \context            $context    The context being stored.
param: array               $subcontext The subcontext path to check.
return: array

assert_all_own_ratings_on_context(int $userid,\context $context,array $subcontext,$component,$ratingarea,$itemid)   X-Ref
Check that all included ratings belong to the specified user.

param: int                 $userid     The ID of the user being stored.
param: \context            $context    The context being stored.
param: array               $subcontext The subcontext path to check.
param: string              $component  The component being stored.
param: string              $ratingarea The rating area to store results for.
param: int                 $itemid     The itemid to store.

assert_all_ratings_on_context(\context $context, array $subcontext, $component, $ratingarea, $itemid)   X-Ref
Check that all included ratings are valid. They may belong to any user.

param: \context            $context    The context being stored.
param: array               $subcontext The subcontext path to check.
param: string              $component  The component being stored.
param: string              $ratingarea The rating area to store results for.
param: int                 $itemid     The itemid to store.

assert_rating_matches($expected, $stored)   X-Ref
Assert that the rating matches.

param: \stdClass           $expected   The expected rating structure
param: \stdClass           $stored     The actual rating structure