CRM_Report_Interface

interface CRM_Report_Interface

Methods

__construct(array $formValues)

The constructor gets the submitted form values.

buildForm(CRM_Core_Form $form)

Builds the quickform for this search.

count()

Count of records that match the current input parameters Used by pager.

summary()

Summary information for the query that can be displayed in the template.

contactIDs(int $offset = 0, int $rowcount = 0, string $sort = NULL)

Get contact IDs.

all(int $offset = 0, int $rowcount = 0, string $sort = NULL, bool $includeContactIDs = FALSE)

Retrieve all the values that match the current input parameters used by the selector.

from()

The from clause for the query.

where(bool $includeContactIDs = FALSE)

The where clause for the query.

templateFile()

The template FileName to use to display the results.

columns()

Returns an array of column headers and field names and sort options.

Details

at line 40
__construct(array $formValues)

The constructor gets the submitted form values.

Parameters

array $formValues

at line 47
buildForm(CRM_Core_Form $form)

Builds the quickform for this search.

Parameters

CRM_Core_Form $form

at line 59
count()

Count of records that match the current input parameters Used by pager.

at line 66
summary()

Summary information for the query that can be displayed in the template.

This is useful to pass total / sub total information if needed

at line 79
contactIDs(int $offset = 0, int $rowcount = 0, string $sort = NULL)

Get contact IDs.

List of contact ids that match the current input parameters Used by different tasks. Will be also used to optimize the 'all' query below to avoid excessive LEFT JOIN blowup

Parameters

int $offset
int $rowcount
string $sort

at line 89
all(int $offset = 0, int $rowcount = 0, string $sort = NULL, bool $includeContactIDs = FALSE)

Retrieve all the values that match the current input parameters used by the selector.

Parameters

int $offset
int $rowcount
string $sort
bool $includeContactIDs

at line 106
from()

The from clause for the query.

at line 113
where(bool $includeContactIDs = FALSE)

The where clause for the query.

Parameters

bool $includeContactIDs

at line 118
templateFile()

The template FileName to use to display the results.

at line 123
columns()

Returns an array of column headers and field names and sort options.