core_reportbuilder\local\helpers\user_filter_manager Class Reference

Static Public Member Functions
static	get (int $reportid, int $userid=null)
	Get user filters for given report.
static	get_all_for_user (int $userid)
	Get all report filters for given user.
static	merge (int $reportid, array $values, int $userid=null)
	Merge individual user filter values for given report.
static	reset_all (int $reportid, int $userid=null, int $index=0)
	Reset all user filters for given report.
static	reset_single (int $reportid, string $uniqueidentifier, int $userid=null)
	Reset single user filter for given report.
static	set (int $reportid, array $values, int $userid=null)
	Set user filters for given report.

Member Function Documentation

get()

static core_reportbuilder\local\helpers\user_filter_manager::get ( int $reportid, int $userid = null )

static

Get user filters for given report.

Parameters

int	$reportid
int | null	$userid

Return values

array

get_all_for_user()

static core_reportbuilder\local\helpers\user_filter_manager::get_all_for_user ( int $userid )

static

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.

Parameters

int

$userid

Return values

array

merge()

static core_reportbuilder\local\helpers\user_filter_manager::merge ( int $reportid, array $values, int $userid = null )

static

Merge individual user filter values for given report.

Parameters

int	$reportid
array	$values
int | null	$userid

Return values

bool

reset_all()

static core_reportbuilder\local\helpers\user_filter_manager::reset_all ( int $reportid, int $userid = null, int $index = 0 )

static

Reset all user filters for given report.

Parameters

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

Return values

bool

reset_single()

static core_reportbuilder\local\helpers\user_filter_manager::reset_single ( int $reportid, string $uniqueidentifier, int $userid = null )

static

Reset single user filter for given report.

Parameters

int	$reportid
string	$uniqueidentifier
int | null	$userid

Return values

bool

set()

static core_reportbuilder\local\helpers\user_filter_manager::set ( int $reportid, array $values, int $userid = null )

static

Set user filters for given report.

Parameters

int	$reportid
array	$values
int | null	$userid

Return values

bool

---

The documentation for this class was generated from the following file:

• reportbuilder/classes/local/helpers/user_filter_manager.php