CRM_Contact_Form_Search_Custom_FullText_Activity

class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery

Properties

protected string $name from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
protected string $label from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery

Methods

__construct()

Class constructor.

string
getLabel()

Get label.

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
string
getName()

Get name.

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
array
fillTempTable(string $queryText, string $entityIDTableName, $toTable, array|null $queryLimit, array|null $detailLimit)

No description

bool
isActive()

Is search active for this user.

fillCustomInfo($tables, $extends)

No description

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
array
runQueries(string $queryText, array $tables, string $entityIDTableName, int $limit)

Run queries.

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
string
matchText(string $table, array|string $fullTextFields, string $queryText)

Create a SQL expression for matching against a list of.

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
moveFileIDs(string $toTable, string $parentIdColumn, array $files)

For any records in $toTable that originated with this query, append file information.

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
string
toLimit(int|array $limit)

No description

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
array
parseLimitOffset(array|int $limit)

No description

from CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
array
prepareQueries(string $queryText, string $entityIDTableName)

No description

moveIDs(string $fromTable, string $toTable, int $limit)

Move IDs.

Details

at line 38
__construct()

Class constructor.

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 61
string getLabel()

Get label.

Return Value

string

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 70
string getName()

Get name.

Return Value

string

at line 54
array fillTempTable(string $queryText, string $entityIDTableName, $toTable, array|null $queryLimit, array|null $detailLimit)

Parameters

string $queryText A string of text to search for.
string $entityIDTableName A temporary table into which we can write a list of all matching IDs.
$toTable
array|null $queryLimit overall limit (applied when building $entityIDTableName) NULL if no limit; or array(0 => $limit, 1 => $offset)
array|null $detailLimit final limit (applied when building $detailTable) NULL if no limit; or array(0 => $limit, 1 => $offset)

Return Value

array keys: match-descriptor - count: int

at line 47
bool isActive()

Is search active for this user.

Return Value

bool

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 109
fillCustomInfo($tables, $extends)

Parameters

$tables
$extends

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 151
array runQueries(string $queryText, array $tables, string $entityIDTableName, int $limit)

Run queries.

Parameters

string $queryText
array $tables A list of places to query. Keys may be:. - sql: an array of SQL queries to execute - final: an array of SQL queries to execute at the end - *: All other keys are treated as table names
string $entityIDTableName
int $limit

Return Value

array Keys: match-descriptor - count: int - files: NULL | array

Exceptions

CRM_Core_Exception

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 264
string matchText(string $table, array|string $fullTextFields, string $queryText)

Create a SQL expression for matching against a list of.

text columns.

Parameters

string $table Eg "civicrm_note" or "civicrm_note mynote".
array|string $fullTextFields list of field names
string $queryText

Return Value

string SQL, eg "MATCH (col1) AGAINST (queryText)" or "col1 LIKE '%queryText%'"

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 277
moveFileIDs(string $toTable, string $parentIdColumn, array $files)

For any records in $toTable that originated with this query, append file information.

Parameters

string $toTable
string $parentIdColumn
array $files See return format of CRM_Core_FileSearchInterface::search.

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 314
string toLimit(int|array $limit)

Parameters

int|array $limit

Return Value

string SQL

See also

CRM_Contact_Form_Search_Custom_FullText::toLimit

in CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery at line 333
array parseLimitOffset(array|int $limit)

Parameters

array|int $limit

Return Value

array (0 => $limit, 1 => $offset)

at line 71
array prepareQueries(string $queryText, string $entityIDTableName)

Parameters

string $queryText
string $entityIDTableName

Return Value

array list tables/queries (for runQueries)

at line 134
moveIDs(string $fromTable, string $toTable, int $limit)

Move IDs.

Parameters

string $fromTable
string $toTable
int $limit