Documentation

CRM_Mailing_BAO_Query
in package

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Methods

buildSearchForm()  : mixed
Add all the elements shared between Mailing search and advnaced search.
defaultReturnProperties()  : array<string|int, mixed>|null
from()  : null|string
getFields()  : array<string|int, mixed>
Get fields for the mailing & mailing job entity.
getSearchFieldMetadata()  : mixed
Get the metadata for fields to be included on the mailing search form.
mailingEventQueryBuilder()  : mixed
Filter query results based on which contacts do (not) have a particular mailing event in their history.
searchAction()  : mixed
select()  : mixed
If mailings are involved, add the specific Mailing fields
tableNames()  : mixed
where()  : mixed
whereClauseSingle()  : mixed

Methods

defaultReturnProperties()

public static defaultReturnProperties(mixed $mode[, bool $includeCustomFields = TRUE ]) : array<string|int, mixed>|null
Parameters
$mode : mixed
$includeCustomFields : bool = TRUE
Return values
array<string|int, mixed>|null

from()

public static from(string $name, int $mode, string $side) : null|string
Parameters
$name : string
$mode : int
$side : string
Return values
null|string

getFields()

Get fields for the mailing & mailing job entity.

public static & getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSearchFieldMetadata()

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

public static getSearchFieldMetadata() : mixed
Tags
throws
CRM_Core_Exception
todo

ideally this would be a trait included on the mailing search & advanced search rather than a static function.

mailingEventQueryBuilder()

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

public static mailingEventQueryBuilder(mixed &$query, mixed &$values, string $tableName, string $fieldName, mixed $fieldTitle, mixed &$valueTitles) : mixed
Parameters
$query : mixed
$values : mixed
$tableName : string
$fieldName : string
$fieldTitle : mixed
$valueTitles : mixed

searchAction()

public static searchAction(mixed &$row, int $id) : mixed
Parameters
$row : mixed
$id : int

select()

If mailings are involved, add the specific Mailing fields

public static select(mixed &$query) : mixed
Parameters
$query : mixed

tableNames()

public static tableNames(mixed &$tables) : mixed
Parameters
$tables : mixed

where()

public static where(mixed &$query) : mixed
Parameters
$query : mixed

whereClauseSingle()

public static whereClauseSingle(mixed &$values, mixed &$query) : mixed
Parameters
$values : mixed
$query : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results