CRM_Report_Utils_Report

class CRM_Report_Utils_Report

Methods

static null|string
getValueFromUrl(int $instanceID = NULL)

No description

static array|bool
getValueIDFromUrl(int $instanceID = NULL)

No description

static mixed
getInstanceIDForValue($optionVal)

No description

static mixed
getInstanceIDForPath(null $path = NULL)

No description

static bool|string
getNextUrl($urlValue, string $query = 'reset=1', bool $absolute = FALSE, int $instanceID = NULL, array $drilldownReport = [])

No description

static int|null|string
getInstanceCount($optionVal)

get instance count for a template.

static bool
mailReport($fileContent, int $instanceID = NULL, string $outputMode = 'html', array $attachments = [])

No description

static 
export2csv(CRM_Core_Form $form, $rows)

No description

static string
makeCsv(CRM_Core_Form $form, array $rows)

Utility function for export2csv and CRM_Report_Form::endPostProcess - make CSV file content and return as string.

static mixed
getInstanceID()

No description

static string
getInstancePath()

No description

static bool
isInstancePermissioned(int $instanceId)

No description

static bool
isInstanceGroupRoleAllowed(int $instanceId)

Check if the user can view a report instance based on their role(s)

static array
processReport(array $params)

No description

static string
getPreviewCriteriaQueryParams(array $defaults = [], array $params = [])

Build a URL query string containing all report filter criteria that are stipulated in $_GET or in a report Preview, but which haven't yet been saved in the report instance.

static mixed
getInstanceList($reportUrl)

No description

Details

at line 42
static null|string getValueFromUrl(int $instanceID = NULL)

Parameters

int $instanceID

Return Value

null|string

at line 69
static array|bool getValueIDFromUrl(int $instanceID = NULL)

Parameters

int $instanceID

Return Value

array|bool

at line 85
static mixed getInstanceIDForValue($optionVal)

Parameters

$optionVal

Return Value

mixed

at line 104
static mixed getInstanceIDForPath(null $path = NULL)

Parameters

null $path

Return Value

mixed

at line 130
static bool|string getNextUrl($urlValue, string $query = 'reset=1', bool $absolute = FALSE, int $instanceID = NULL, array $drilldownReport = [])

Parameters

$urlValue
string $query
bool $absolute
int $instanceID
array $drilldownReport

Return Value

bool|string

at line 163
static int|null|string getInstanceCount($optionVal)

get instance count for a template.

Parameters

$optionVal

Return Value

int|null|string

at line 186
static bool mailReport($fileContent, int $instanceID = NULL, string $outputMode = 'html', array $attachments = [])

Parameters

$fileContent
int $instanceID
string $outputMode
array $attachments

Return Value

bool

at line 224
static export2csv(CRM_Core_Form $form, $rows)

Parameters

CRM_Core_Form $form
$rows

at line 244
static string makeCsv(CRM_Core_Form $form, array $rows)

Utility function for export2csv and CRM_Report_Form::endPostProcess - make CSV file content and return as string.

Parameters

CRM_Core_Form $form
array $rows

Return Value

string

at line 311
static mixed getInstanceID()

Return Value

mixed

at line 328
static string getInstancePath()

Return Value

string

at line 346
static bool isInstancePermissioned(int $instanceId)

Parameters

int $instanceId

Return Value

bool

at line 379
static bool isInstanceGroupRoleAllowed(int $instanceId)

Check if the user can view a report instance based on their role(s)

Parameters

int $instanceId

Return Value

bool true if yes, else false

at line 409
static array processReport(array $params)

Parameters

array $params

Return Value

array

at line 481
static string getPreviewCriteriaQueryParams(array $defaults = [], array $params = [])

Build a URL query string containing all report filter criteria that are stipulated in $_GET or in a report Preview, but which haven't yet been saved in the report instance.

Parameters

array $defaults The report criteria that aren't coming in as submitted form values, as in CRM_Report_Form::_defaults.
array $params All effective report criteria, as in CRM_Report_Form::_params.

Return Value

string URL query string

at line 555
static mixed getInstanceList($reportUrl)

Parameters

$reportUrl

Return Value

mixed