CRM_Pledge_BAO_Query

class CRM_Pledge_BAO_Query extends CRM_Core_BAO_Query

Methods

static 
addCustomFormFields(CRM_Core_Form $form, array $extends)

No description

from CRM_Core_BAO_Query
static array
getLegacySupportedFields()

Get legacy fields which we still maybe support.

from CRM_Core_BAO_Query
string
qill()

Getter for the qill object.

from CRM_Core_BAO_Query
static 
searchAction($row, int $id)

Possibly unnecessary function.

from CRM_Core_BAO_Query
static 
tableNames($tables)

No description

static string
getFieldName(array $values)

Get the name of the field.

from CRM_Core_BAO_Query
static array
getFields(bool $checkPermission = TRUE)

Get pledge fields.

static 
select(CRM_Contact_BAO_Query $query)

Build select for Pledge.

static 
where($query)

No description

static 
whereClauseSingle(array $values, CRM_Contact_BAO_Query $query)

Get where clause for field.

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

From clause.

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

Ideally this function should include fields that are displayed in the selector.

static array|null
extraReturnProperties(string $mode)

This includes any extra fields that might need for export etc.

static 
getSearchFieldMetadata()

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

static 
getPledgePaymentSearchFieldMetadata()

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

static 
buildSearchForm(CRM_Pledge_Form_Search|CRM_Contact_Form_Search_Advanced $form)

Build the search for for pledges.

Details

in CRM_Core_BAO_Query at line 41
static addCustomFormFields(CRM_Core_Form $form, array $extends)

Parameters

CRM_Core_Form $form
array $extends

in CRM_Core_BAO_Query at line 69
static protected array getLegacySupportedFields()

Get legacy fields which we still maybe support.

These are contribution specific but I think it's ok to have one list of legacy supported params in a central place.

Return Value

array

in CRM_Core_BAO_Query at line 87
string qill()

Getter for the qill object.

Return Value

string

in CRM_Core_BAO_Query at line 97
static searchAction($row, int $id)

Possibly unnecessary function.

Parameters

$row
int $id

at line 612
static tableNames($tables)

Parameters

$tables

in CRM_Core_BAO_Query at line 111
static protected string getFieldName(array $values)

Get the name of the field.

Parameters

array $values

Return Value

string

at line 42
static array getFields(bool $checkPermission = TRUE)

Get pledge fields.

Parameters

bool $checkPermission

Return Value

array

at line 51
static select(CRM_Contact_BAO_Query $query)

Build select for Pledge.

Parameters

CRM_Contact_BAO_Query $query

at line 231
static where($query)

Parameters

$query

at line 257
static whereClauseSingle(array $values, CRM_Contact_BAO_Query $query)

Get where clause for field.

Parameters

array $values
CRM_Contact_BAO_Query $query

Exceptions

CRM_Core_Exception

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

From clause.

Parameters

string $name
string $mode
string $side

Return Value

null|string

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

Ideally this function should include fields that are displayed in the selector.

Parameters

int $mode
bool $includeCustomFields

Return Value

array|null

at line 485
static array|null extraReturnProperties(string $mode)

This includes any extra fields that might need for export etc.

Parameters

string $mode

Return Value

array|null

at line 518
static getSearchFieldMetadata()

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

Exceptions

CiviCRM_API3_Exception

at line 534
static getPledgePaymentSearchFieldMetadata()

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

Exceptions

CiviCRM_API3_Exception

at line 550
static buildSearchForm(CRM_Pledge_Form_Search|CRM_Contact_Form_Search_Advanced $form)

Build the search for for pledges.

Parameters

CRM_Pledge_Form_Search|CRM_Contact_Form_Search_Advanced $form

Exceptions

CRM_Core_Exception
CiviCRM_API3_Exception