class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface

Constants

LIMIT

Properties

protected $_formValues
protected $_columns
protected $_stateID from CRM_Contact_Form_Search_Custom_Base
protected array $_partialQueries
protected $_text
protected $_table
protected $_tableName
protected $_entityIDTableName
protected $_tableFields
protected array|null $_limitClause
protected array|null $_limitRowClause
protected array|null $_limitDetailClause
protected $_limitNumber
protected $_limitNumberPlus1
protected $_foundRows

Methods

__construct(array $formValues)

Class constructor.

array
buildTaskList( $form)

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

null|string
count()

No description

null
summary()

No description

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

No description

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

No description

null
templateFile()

No description

columns()

No description

static 
includeContactIDs($sql, $formValues)

No description

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

No description

validateUserSQL($sql, bool $onlyWhere = FALSE)

No description

string
whereClause($where, array $params)

No description

null
getQueryObj()

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

setTitle(string $title)

No description

mixed|null
getFieldValue($formValues, $field, $type, null $default = NULL)

Get a value from $formValues. If missing, get it from the request.

__destruct()

No description

initialize()

No description

buildTempTable()

No description

fillTable()

No description

filterACLContacts()

No description

buildForm(CRM_Core_Form $form)

No description

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

No description

from()

No description

where(bool $includeContactIDs = FALSE)

No description

array
setDefaultValues()

No description

alterRow($row)

No description

string
toLimit(int|array $limit)

No description

Details

at line 81
__construct(array $formValues)

Class constructor.

Parameters

array $formValues

array buildTaskList( $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

$form

Return Value

array

at line 429
null|string count()

Return Value

null|string

at line 362
null summary()

Return Value

null

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

Parameters

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

Return Value

string

string sql($selectClause, int $offset, int $rowcount, 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 508
null templateFile()

Return Value

null

at line 350
columns()

static includeContactIDs($sql, $formValues)

Parameters

$sql
$formValues

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

Parameters

$sql
$offset
$rowcount
$sort

validateUserSQL($sql, bool $onlyWhere = FALSE)

Parameters

$sql
bool $onlyWhere

Exceptions

Exception

string whereClause($where, array $params)

Parameters

$where
array $params

Return Value

string

null getQueryObj()

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

Return Value

null

at line 528
setTitle(string $title)

Parameters

string $title

at line 126
mixed|null getFieldValue($formValues, $field, $type, null $default = NULL)

Get a value from $formValues. If missing, get it from the request.

Parameters

$formValues
$field
$type
null $default

Return Value

mixed|null

at line 134
__destruct()

at line 137
initialize()

at line 149
buildTempTable()

at line 233
fillTable()

at line 247
filterACLContacts()

at line 296
buildForm(CRM_Core_Form $form)

Parameters

CRM_Core_Form $form

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

Parameters

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

at line 492
from()

at line 501
where(bool $includeContactIDs = FALSE)

Parameters

bool $includeContactIDs

at line 515
array setDefaultValues()

Return Value

array

at line 522
alterRow($row)

Parameters

$row

at line 540
string toLimit(int|array $limit)

Parameters

int|array $limit

Return Value

string SQL

See also

CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery::toLimit