CRM_Mailing_BAO_Query

class CRM_Mailing_BAO_Query

Methods

static array
getFields()

Get fields for the mailing & mailing job entity.

static 
select($query)

If mailings are involved, add the specific Mailing fields

static 
getSearchFieldMetadata()

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

static 
where($query)

No description

static null|string
from(string $name, $mode, $side)

No description

static array|null
defaultReturnProperties($mode, bool $includeCustomFields = TRUE)

No description

static 
whereClauseSingle($values, $query)

No description

static 
buildSearchForm(CRM_Mailing_Form_Search $form)

Add all the elements shared between Mailing search and advnaced search.

static 
searchAction($row, int $id)

No description

static 
tableNames($tables)

No description

static 
mailingEventQueryBuilder($query, $values, string $tableName, string $fieldName, $fieldTitle, $valueTitles)

Filter query results based on which contacts do (not) have a particular mailing event in their history.

Details

at line 40
static array getFields()

Get fields for the mailing & mailing job entity.

Return Value

array

at line 59
static select($query)

If mailings are involved, add the specific Mailing fields

Parameters

$query

at line 140
static getSearchFieldMetadata()

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

Exceptions

CiviCRM_API3_Exception

at line 150
static where($query)

Parameters

$query

at line 173
static null|string from(string $name, $mode, $side)

Parameters

string $name
$mode
$side

Return Value

null|string

at line 224
static array|null defaultReturnProperties($mode, bool $includeCustomFields = TRUE)

Parameters

$mode
bool $includeCustomFields

Return Value

array|null

at line 254
static whereClauseSingle($values, $query)

Parameters

$values
$query

at line 412
static buildSearchForm(CRM_Mailing_Form_Search $form)

Add all the elements shared between Mailing search and advnaced search.

Parameters

CRM_Mailing_Form_Search $form

Exceptions

CiviCRM_API3_Exception

at line 461
static searchAction($row, int $id)

Parameters

$row
int $id

at line 467
static tableNames($tables)

Parameters

$tables

at line 485
static mailingEventQueryBuilder($query, $values, string $tableName, string $fieldName, $fieldTitle, $valueTitles)

Filter query results based on which contacts do (not) have a particular mailing event in their history.

Parameters

$query
$values
string $tableName
string $fieldName
$fieldTitle
$valueTitles