CRM_Contact_Form_Search_Custom_ContributionAggregate

class CRM_Contact_Form_Search_Custom_ContributionAggregate extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface

Properties

protected $_formValues
protected $_columns from CRM_Contact_Form_Search_Custom_Base
protected $_stateID from CRM_Contact_Form_Search_Custom_Base
protected $_aclFrom
protected $_aclWhere
$_permissionedComponent

Methods

__construct(array $formValues)

Class constructor.

array
buildTaskList(CRM_Core_Form_Search $form)

Builds the list of tasks or actions that a searcher can perform on a result set.

from CRM_Contact_Form_Search_Custom_Base
null|string
count()

No description

null
summary()

No description

string
contactIDs(int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $returnSQL = TRUE)

No description

string
sql($selectClause, int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $includeContactIDs = FALSE, null $groupBy = NULL)

No description

from CRM_Contact_Form_Search_Custom_Base
null
templateFile()

Define the smarty template used to layout the search form and results listings.

columns()

No description

static 
includeContactIDs($sql, $formValues)

No description

from CRM_Contact_Form_Search_Custom_Base
addSortOffset($sql, $offset, $rowcount, $sort)

No description

from CRM_Contact_Form_Search_Custom_Base
validateUserSQL($sql, bool $onlyWhere = FALSE)

No description

from CRM_Contact_Form_Search_Custom_Base
string
whereClause($where, array $params)

No description

from CRM_Contact_Form_Search_Custom_Base
null
getQueryObj()

override this method to define the contact query object used for creating $sql

from CRM_Contact_Form_Search_Custom_Base
setTitle(string $title)

No description

array
formRule(array $fields, array $files, CRM_Core_Form $self)

Validate form input.

from CRM_Contact_Form_Search_Custom_Base
buildForm(CRM_Core_Form $form)

Build form.

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

Construct the search query.

from()

No description

static 
getSearchFieldMetadata()

Get the metadata for fields to be included on the contact search form.

where(bool $includeContactIDs = FALSE)

WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.

string
having(bool $includeContactIDs = FALSE)

No description

buildACLClause(string $tableAlias = 'contact')

No description

Details

at line 45
__construct(array $formValues)

Class constructor.

Parameters

array $formValues

in CRM_Contact_Form_Search_Custom_Base at line 59
array buildTaskList(CRM_Core_Form_Search $form)

Builds the list of tasks or actions that a searcher can perform on a result set.

The returned array completely replaces the task list, so a child class that wants to modify the existing list should manipulate the result of this method.

Parameters

CRM_Core_Form_Search $form

Return Value

array

at line 310
null|string count()

Return Value

null|string

at line 351
null summary()

Return Value

null

at line 325
string contactIDs(int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $returnSQL = TRUE)

Parameters

int $offset
int $rowcount
null $sort
bool $returnSQL

Return Value

string

in CRM_Contact_Form_Search_Custom_Base at line 111
string sql($selectClause, int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $includeContactIDs = FALSE, null $groupBy = NULL)

Parameters

$selectClause
int $offset
int $rowcount
null $sort
bool $includeContactIDs
null $groupBy

Return Value

string

at line 105
null templateFile()

Define the smarty template used to layout the search form and results listings.

Return Value

null

at line 332
columns()

in CRM_Contact_Form_Search_Custom_Base at line 155
static includeContactIDs($sql, $formValues)

Parameters

$sql
$formValues

in CRM_Contact_Form_Search_Custom_Base at line 177
addSortOffset($sql, $offset, $rowcount, $sort)

Parameters

$sql
$offset
$rowcount
$sort

in CRM_Contact_Form_Search_Custom_Base at line 202
validateUserSQL($sql, bool $onlyWhere = FALSE)

Parameters

$sql
bool $onlyWhere

Exceptions

Exception

in CRM_Contact_Form_Search_Custom_Base at line 233
string whereClause($where, array $params)

Parameters

$where
array $params

Return Value

string

in CRM_Contact_Form_Search_Custom_Base at line 242
null getQueryObj()

override this method to define the contact query object used for creating $sql

Return Value

null

at line 339
setTitle(string $title)

Parameters

string $title

in CRM_Contact_Form_Search_Custom_Base at line 270
array formRule(array $fields, array $files, CRM_Core_Form $self)

Validate form input.

Parameters

array $fields
array $files
CRM_Core_Form $self

Return Value

array Input errors from the form.

at line 65
buildForm(CRM_Core_Form $form)

Build form.

Parameters

CRM_Core_Form $form

at line 120
all(int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $includeContactIDs = FALSE, bool $justIDs = FALSE)

Construct the search query.

Parameters

int $offset
int $rowcount
null $sort
bool $includeContactIDs
bool $justIDs

at line 181
from()

at line 194
static getSearchFieldMetadata()

Get the metadata for fields to be included on the contact search form.

at line 212
where(bool $includeContactIDs = FALSE)

WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.

Parameters

bool $includeContactIDs

at line 286
string having(bool $includeContactIDs = FALSE)

Parameters

bool $includeContactIDs

Return Value

string

at line 358
buildACLClause(string $tableAlias = 'contact')

Parameters

string $tableAlias