ReportTemplate.php
This api exposes CiviCRM report templates.
Table of Contents
Functions
- civicrm_api3_report_template_get() : array<string|int, mixed>
- Retrieve a report template.
- civicrm_api3_report_template_create() : array<string|int, mixed>
- Add a Report Template.
- _civicrm_api3_report_template_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_report_template_delete() : array<string|int, mixed>
- Deletes an existing ReportTemplate.
- civicrm_api3_report_template_getrows() : array<string|int, mixed>
- Retrieve rows from a report template.
- _civicrm_api3_report_template_getrows() : array<string|int, mixed>
- Get report template rows.
- civicrm_api3_report_template_getstatistics() : array<string|int, mixed>
- Get statistics from a given report.
- _civicrm_api3_report_template_getrows_spec() : mixed
- Adjust metadata for template getrows action.
Functions
civicrm_api3_report_template_get()
Retrieve a report template.
civicrm_api3_report_template_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
civicrm_api3_report_template_create()
Add a Report Template.
civicrm_api3_report_template_create(array<string|int, mixed> $params) : array<string|int, mixed>
Templates are stored as OptionValues.
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array
_civicrm_api3_report_template_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_report_template_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_report_template_delete()
Deletes an existing ReportTemplate.
civicrm_api3_report_template_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array
civicrm_api3_report_template_getrows()
Retrieve rows from a report template.
civicrm_api3_report_template_getrows(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed> —API result array
_civicrm_api3_report_template_getrows()
Get report template rows.
_civicrm_api3_report_template_getrows(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>civicrm_api3_report_template_getstatistics()
Get statistics from a given report.
civicrm_api3_report_template_getstatistics(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array
_civicrm_api3_report_template_getrows_spec()
Adjust metadata for template getrows action.
_civicrm_api3_report_template_getrows_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Input parameters.