CRM_Contact_Form_Search_Custom_Group

class CRM_Contact_Form_Search_Custom_Group 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 $_tableName
protected $_where
protected $_aclFrom
protected $_aclWhere

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()

Get summary.

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

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()

Get template file.

columns()

Define columns.

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)

Set title on search.

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

Validate form input.

from CRM_Contact_Form_Search_Custom_Base
__destruct()

No description

buildForm(CRM_Core_Form $form)

No description

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

No description

from()

No description

where(bool $includeContactIDs = FALSE)

No description

buildACLClause(string $tableAlias = 'contact')

Build ACL clause.

Details

at line 49
__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 581
null|string count()

Return Value

null|string

at line 615
null summary()

Get summary.

Return Value

null

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

Parameters

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

Return Value

string

Exceptions

Exception

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 624
null templateFile()

Get template file.

Return Value

null

at line 606
columns()

Define 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 633
setTitle(string $title)

Set title on search.

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 83
__destruct()

at line 92
buildForm(CRM_Core_Form $form)

Parameters

CRM_Core_Form $form

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

Parameters

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

Exceptions

Exception

at line 242
from()

Exceptions

Exception

at line 549
where(bool $includeContactIDs = FALSE)

Parameters

bool $includeContactIDs

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

Build ACL clause.

Parameters

string $tableAlias