Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/reportbuilder/classes/local/helpers/ -> user_filter_manager.php (source)

[Source view]

(no description)

File Size: 175 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

user_filter_manager:: (7 methods):
  user_preference_name()
  set()
  get()
  merge()
  reset_all()
  reset_single()
  get_all_for_user()


Class: user_filter_manager  - X-Ref

This class handles the setting and retrieving of a users' filter values for given reports

It is currently using the user preference API as a storage mechanism

user_preference_name(int $reportid, int $index)   X-Ref
Generate user preference name for given report

return: string
param: int $reportid
param: int $index

set(int $reportid, array $values, int $userid = null)   X-Ref
Set user filters for given report

return: bool
param: int $reportid
param: array $values
param: int|null $userid

get(int $reportid, int $userid = null)   X-Ref
Get user filters for given report

return: array
param: int $reportid
param: int|null $userid

merge(int $reportid, array $values, int $userid = null)   X-Ref
Merge individual user filter values for given report

return: bool
param: int $reportid
param: array $values
param: int|null $userid

reset_all(int $reportid, int $userid = null, int $index = 0)   X-Ref
Reset all user filters for given report

return: bool
param: int $reportid
param: int|null $userid
param: int $index If specified, then preferences will be reset starting from this index

reset_single(int $reportid, string $uniqueidentifier, int $userid = null)   X-Ref
Reset single user filter for given report

return: bool
param: int $reportid
param: string $uniqueidentifier
param: int|null $userid

get_all_for_user(int $userid)   X-Ref
Get all report filters for given user

This is primarily designed for the privacy provider, and allows us to preserve all the preference logic within this class.

return: array
param: int $userid