Documentation

CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet
in package

CRM

implements HookInterface

Business object for managing price sets.

Interfaces

HookInterface: Interface HookInterface

Constants

BULK_INSERT_COUNT = 200
BULK_INSERT_HIGH_COUNT = 200
DB_DAO_NOTNULL = 128
IS_NULL = 2
NOT_NULL = 1
QUERY_FORMAT_NO_QUOTES = 2
QUERY_FORMAT_WILDCARD = 1
SERIALIZE_COMMA = 5: Comma separated string, no quotes, no spaces
SERIALIZE_JSON = 3: Recommended serialization format
SERIALIZE_NONE = 0: No serialization.
SERIALIZE_PHP = 4
SERIALIZE_SEPARATOR_BOOKEND = 1: Serialized string separated by and bookended with VALUE_SEPARATOR
SERIALIZE_SEPARATOR_TRIMMED = 2
VALUE_SEPARATOR = "\x01"

Properties

$_dbColumnValueCache : mixed
$_defaultPriceSet : array<string|int, mixed>: Static field for default price set details.
$_icon : string: Icon associated with this entity.
$_labelField : string: Field to show when displaying a record.
$_nullArray : array<string|int, mixed>
$_nullObject : null
$_primaryKey : array<string|int, string>: Primary key field(s).
$_testEntitiesToSkip : array<string|int, mixed>: Define entities that shouldn't be created or deleted when creating/ deleting test objects - this prevents world regions, countries etc from being added / deleted
$domain_id : int|string|null
$extends : string
$financial_type_id : int|string|null
$help_post : string|null
$help_pre : string|null
$id : int|string|null
$is_active : bool|string
$is_quick_config : bool|string
$is_reserved : bool|string
$javascript : string|null
$min_amount : float|string|null
$name : string
$title : string
$_options : array<string|int, mixed>: https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings
$resultCopies : int: How many times has this instance been cloned.

Methods

__clone() : mixed
__construct() : static: Class constructor.
__destruct() : mixed: Class destructor.
acceptedSQLOperators() : array<string|int, string>
addSelectWhereClause() : array<string|int, mixed>: Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
addTo() : bool: Link the price set with the specified table and id.
appendPseudoConstantsToFields() : mixed: Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
buildOptions() : array<string|int, mixed>|bool: Legacy field options getter.
buildOptionsContext() : array<string|int, mixed>: Provides documentation and validation for the buildOptions $context param
buildPriceSet() : void: Build the price set form.
cascadeUpdate() : CRM_Core_DAO|null: Cascade update through related entities.
checkAutoRenewForPriceSet() : int: Check if auto renew option should be shown.
checkConstraintExists() : bool: Checks if a constraint exists for a specified table.
checkFieldHasAlwaysValue() : mixed: Check whether a specific column in a specific table has always the same value.
checkFieldIsAlwaysNull() : mixed: Check whether a specific column in a specific table is always NULL.
checkFKConstraintInFormat() : mixed: Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
checkPermission() : bool: check price set permission.
checkTableExists() : bool: Check if there is a given table in the database.
checkTableHasData() : bool: Check if a given table has data.
checkTriggerViewPermission() : bool
commonRetrieveAll() : object: Fetch object based on array of properties.
composeQuery() : string: Compose the query by merging the parameters into it.
copy() : CRM_Price_DAO_PriceSet: Copy a price set, including all the fields
copyCustomFields() : mixed: Method that copies custom fields values from an old entity to a new one.
copyGeneric() : CRM_Core_DAO|bool: Make a shallow copy of an object and all the fields in the object.
copyPriceSet() : mixed: Copy priceSet when event/contibution page is copied
copyValues() : bool: Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
create() : CRM_Price_BAO_PriceSet: Takes an associative array and creates a price set object.
createReferenceColumns() : array<string|int, CRM_Core_Reference_Interface>: Given a list of fields, create a list of references.
createSQLFilter() : null|string|array<string|int, mixed>: Get SQL where clause for SQL filter syntax input parameters.
createTestObject() : object|array<string|int, mixed>|null: Creates a test object, including any required objects it needs via recursion createOnly: only create in database, do not store or return the objects (useful for perf testing) ONLY USE FOR TESTING
createTriggers() : mixed
debugPrint() : mixed
delete() : int|false: Deletes items from table which match current objects variables.
deleteEntityContact() : mixed: Unused function.
deleteRecord() : static: Delete a record from supplied params.
deleteRecords() : array<string|int, static>: Bulk delete multiple records.
deleteSet() : bool: Delete the price set, including the fields.
deleteTestObjects() : mixed: Deletes the this object plus any dependent objects that are associated with it.
disableFullGroupByMode() : mixed: Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
dropAllTables() : mixed: Drop all CiviCRM tables.
dropTriggers() : mixed: Wrapper function to drop triggers.
escapeString() : string
escapeStrings() : string: Escape a list of strings for use with "WHERE X IN (...)" queries.
escapeWildCardString() : string
eventPriceSetDomainID() : object
executeQuery() : CRM_Core_DAO|object: Execute a query.
executeUnbufferedQuery() : CRM_Core_DAO: Execute an unbuffered query.
export() : array<string|int, mixed>: Returns the list of fields that can be exported
fetchAll() : array<string|int, mixed>: Returns all results as array-encoded records.
fetchGenerator() : mixed: Return the results as PHP generator.
fetchMap() : array<string|int, mixed>: Get all the result records as mapping between columns.
fetchValue() : mixed|null: Returns a singular value.
fieldKeys() : array<string|int, mixed>: Return a mapping from field-name to the corresponding key (as used in fields()).
fields() : array<string|int, mixed>: Returns all the column names of this table.
fillValues() : array<string|int, mixed>: Given an incomplete record, attempt to fill missing field values from the database
filterPriceFieldsFromParams() : array<string|int, mixed>: Get the fields relevant to the price field from the parameters.
findById() : static: Find a DAO object for the given ID and return it.
findReferences() : array<string|int, CRM_Core_DAO>: Find all records which refer to this entity.
flushPriceSets() : void
formatFieldValues() : void: Format field values according to fields() metadata.
freeResult() : mixed
getAmountLevelText() : string: Get the text to record for amount level.
getAssoc() : array<string|int, mixed>: Return an associative array of all price sets.
getAttribute() : array<string|int, mixed>: Get the size and maxLength attributes for this text field.
getCachedPriceSetDetail() : array<string|int, mixed>: Get PriceSet + Fields + FieldValues nested, with caching.
getConnection() : DB_common
getContactIDsFromComponent() : array<string|int, mixed>: Given the component id, compute the contact id since its used for things like send email
getDatabaseName() : string: Get the name of the CiviCRM database.
getDbVal() : array<string|int, mixed>|bool|int|string|null: Fetch a single field value from the database.
getDefaultFallbackValues() : mixed: Callback for `default_fallback` field values
getDefaultPriceSet() : array<string|int, mixed>: Calculate the default price set id assigned to the contribution/membership etc
getDynamicReferencesToTable() : array<string|int, mixed>: Get all dynamic references to the given table.
getEntityDescription() : string|null: Returns user-friendly description of this entity.
getEntityIcon() : string|null: Overridable function to get icon for a particular entity.
getEntityPaths() : array<string|int, mixed>: Returns system paths related to this entity (as defined in the xml schema)
getEntityRefFilters() : array<string|int, mixed>
getEntityTitle() : string: Returns localized title of this entity.
getExportableFieldsWithPseudoConstants() : array<string|int, mixed>: Get exportable fields with pseudoconstants rendered as an extra field.
getExtendsOptions() : array<string|int, mixed>: Pseudoconstant options for the `extends` field
getExtensionName() : string|null: Get name of extension in which this DAO is defined.
getFieldIds() : array<string|int, mixed>: Get field ids of a price set.
getFieldSpec() : bool|array<string|int, mixed>
getFieldValue() : string|int|null: Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
getFor() : int|false: Find a price_set_id associated with the given table, id and usedFor Used For value for events:1, contribution:2, membership:3
getFormsUsingPriceSet() : array<string|int, mixed>: Get an array of all forms using a given price set.
getGlobalSetting() : mixed: Lookup the value of a MySQL global configuration variable.
getLabelField() : string|null
getLine() : array<string|int, mixed>: Get the relevant line item.
getLocaleTableName() : string: Get localized name of this table, if applicable.
getLog() : bool: Returns if this table needs to be logged
getMembershipCount() : array<string|int, mixed>: Return a count of priceFieldValueIDs that are memberships by organisation and membership type
getMembershipTypesFromPriceSet() : mixed: Get an array of the membership types in a price set.
getNonDeductibleAmountFromPriceSet() : int: Get non-deductible amount from price options
getOnlyPriceFieldID() : int: Get the Price Field ID.
getOnlyPriceFieldValueID() : int: Get the Price Field Value ID. We call this function when more than one being present would represent an error current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))
getOptionLabels() : mixed: Populate option labels for this object's fields.
getPriceFieldValueFromURL() : mixed: Get the value of price field if passed via url
getPricesetCount() : int|null|string: Get the sum of participant count for all fields of given price set.
getReferenceColumns() : array<string|int, CRM_Core_Reference_Basic>: Returns list of FK relationships.
getReferenceCounts() : array<string|int, array{name: string, type: string, count: int, table: string|null, key: string|null}>
getReferencesToContactTable() : mixed: Get all references to contact table.
getReferencesToTable() : array<string|int, CRM_Core_Reference_Interface>: List all tables which have either: - hard foreign keys to this table, or - a dynamic foreign key that includes this table as a possible target.
getSelectWhereClause() : array<string|int, mixed>: This returns the final permissioned query string for this entity
getSetDetail() : array<string|int, mixed>: Get price set details.
getSetId() : int|null: Find a price_set_id associated with the given option value or field ID.
getSortString() : mixed: Unused function.
getSupportedFields() : array<string|int, mixed>: Returns all usable fields, indexed by name.
getTableName() : string: Returns the name of this table
getTableNames() : array<string|int, mixed>: Gets the names of all enabled schema tables.
getTitle() : string: Get the price set title.
getUsedBy() : array<string|int, mixed>: Return a list of all forms which use this price set.
hook_civicrm_post() : void
import() : array<string|int, mixed>: Returns the list of fields that can be imported
indices() : array<string|int, mixed>
init() : mixed: Initialize the DAO object.
initialize() : mixed: Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
isComponentEnabled() : bool: Check if component is enabled for this DAO class
isDBMyISAM() : bool
isMembershipPriceSetContainsMixOfRenewNonRenew() : bool: Check if price set id provides option for user to select both auto-renew and non-auto-renew memberships
isQuickConfig() : bool: Is the price set 'quick config'.
isValidOption() : bool: Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
keys() : array<string|int, string>: Returns primary keys (usually ['id'])
log() : mixed
makeAttribute() : array<string|int, mixed>|null: Create an attribute for this specific field. We only do this for strings and text
objectExists() : bool: Check if there is a record with the same name in the db.
parseFirstPriceSetValueIDFromParams() : array<string|int, mixed>: Get the first price set value IDs from a parameters array.
parsePriceSetArrayFromParams() : array<string|int, mixed>: Get the price set value IDs from a set of parameters
parsePriceSetValueIDsFromParams() : array<string|int, mixed>: Get the price set value IDs from a set of parameters
processAmount() : mixed: Get line item purchase information.
query() : object: Execute a query by the current DAO, localizing it along the way (if needed).
reenableFullGroupByMode() : mixed: Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.
removeFrom() : mixed: Delete price set for the given entity and id.
requireSafeDBName() : bool: ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insensitive.
reset() : mixed: Reset the DAO object.
retrieve() : self|null
save() : CRM_Core_DAO: Save DAO object.
schemaRequiresRebuilding() : mixed: Checks if CONSTRAINT keyword exists for a specified table.
self_hook_civicrm_pre() : mixed: Event fired before an action is taken on an ACL record.
sequenceKey() : array<string|int, mixed>: Tells DB_DataObject which keys use autoincrement.
serializeField() : string|null: Transform an array to a serialized string for database storage.
setApiFilter() : mixed
setCreateDefaults() : mixed: Set defaults when creating new entity.
setDefaultPriceSet() : array<string|int, mixed>: Set daefult the price set fields.
setDefaultPriceSetField() : void: Get the value of price field if passed via url
setFieldValue() : bool: Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
setIsActive() : bool
setIsQuickConfig() : bool: Update the is_quick_config flag in the db.
setLineItem() : array<string|int, mixed>: Function to set tax_amount and tax_rate in LineItem.
setOptions() : mixed: https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
setPriceSets() : mixed: Supports event create function by setting up required price sets, not tested but expect it will work for contribution page
shortenSQLName() : string: SQL has a limit of 64 characters on various names: table name, trigger name, column name ... For custom groups and fields we generated names from user entered input which can be longer than this length, this function helps with creating strings that meet various criteria.
singleValueQuery() : string|null: Execute a query and get the single result.
storeValues() : mixed: Store all the values from this object in an associative array this is a destructive store, calling function is responsible for keeping sanity of id's.
table() : array<string|int, mixed>: Get/set an associative array of table columns
tableHasBeenAdded() : bool: Checks if this DAO's table ought to exist.
triggerRebuild() : mixed: Build a list of triggers via hook and add them to (err, reconcile them with) the database.
unSerializeField() : array<string|int, mixed>|null: Transform a serialized string from the database into an array.
writeRecord() : static: Create or update a record from supplied params.
writeRecords() : array<string|int, static>: Bulk save multiple records
_setDBOptions() : mixed: https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
assignTestFK() : mixed
assignTestValue() : mixed: Generate and assign an arbitrary value to a field of a test object.
copyLocalizable() : mixed: Method that copies localizable fields from an old entity to a new one.
formatFieldValue() : mixed: Format a value according to field metadata.
getDynamicFkAclClauses() : array<string|int, mixed>: Get an array of ACL clauses for a dynamic FK (entity_id/entity_table combo)
getFirstPrimaryKey() : string
getTableAddVersion() : string
reformatUsedByFormsWithEntityData() : mixed
clearDbColumnValueCache() : mixed: Remove item from static cache during update/delete operations
getEntityDefinition() : array<string|int, mixed>
getEntityInfo() : array<string|int, mixed>
getFieldLength() : string|null
getSchemaFields() : array<string|int, mixed>
loadSchemaFields() : array<string|int, mixed>
makeNameFromLabel() : void: When creating a record without a supplied name, create a unique, clean name derived from the label.
setDefaultsFromCallback() : void: Set default values for fields based on callback functions

BULK_INSERT_COUNT


    public
        mixed
    BULK_INSERT_COUNT
    = 200

BULK_INSERT_HIGH_COUNT


    public
        mixed
    BULK_INSERT_HIGH_COUNT
    = 200

DB_DAO_NOTNULL


    public
        mixed
    DB_DAO_NOTNULL
    = 128

IS_NULL


    public
        mixed
    IS_NULL
    = 2

NOT_NULL


    public
        mixed
    NOT_NULL
    = 1

QUERY_FORMAT_NO_QUOTES


    public
        mixed
    QUERY_FORMAT_NO_QUOTES
    = 2

QUERY_FORMAT_WILDCARD


    public
        mixed
    QUERY_FORMAT_WILDCARD
    = 1

SERIALIZE_COMMA

Comma separated string, no quotes, no spaces


    public
        mixed
    SERIALIZE_COMMA
    = 5

SERIALIZE_JSON

Recommended serialization format


    public
        mixed
    SERIALIZE_JSON
    = 3

SERIALIZE_NONE

No serialization.


    public
        mixed
    SERIALIZE_NONE
    = 0

SERIALIZE_PHP

format using php serialize()


    public
        mixed
    SERIALIZE_PHP
    = 4

SERIALIZE_SEPARATOR_BOOKEND

Serialized string separated by and bookended with VALUE_SEPARATOR


    public
        mixed
    SERIALIZE_SEPARATOR_BOOKEND
    = 1

SERIALIZE_SEPARATOR_TRIMMED

format separated by VALUE_SEPARATOR


    public
        mixed
    SERIALIZE_SEPARATOR_TRIMMED
    = 2

VALUE_SEPARATOR


    public
        mixed
    VALUE_SEPARATOR
    = "\x01"

$_dbColumnValueCache


    public
    static    mixed
    $_dbColumnValueCache
     = \NULL

$_defaultPriceSet

Static field for default price set details.


    public
    static    array<string|int, mixed>
    $_defaultPriceSet
     = \NULL

$_icon

Icon associated with this entity.


    public
    static    string
    $_icon
     = \NULL

$_labelField

Field to show when displaying a record.


    public
    static    string
    $_labelField
     = \NULL

$_nullArray


    public
    static    array<string|int, mixed>
    $_nullArray
     = []

$_nullObject


    public
    static    null
    $_nullObject
     = \NULL

$_primaryKey

Primary key field(s).


    public
    static    array<string|int, string>
    $_primaryKey
     = ['id']

$_testEntitiesToSkip

Define entities that shouldn't be created or deleted when creating/ deleting test objects - this prevents world regions, countries etc from being added / deleted


    public
    static    array<string|int, mixed>
    $_testEntitiesToSkip
     = []

$domain_id


    public
        int|string|null
    $domain_id

$extends


    public
        string
    $extends

$financial_type_id


    public
        int|string|null
    $financial_type_id

$help_post


    public
        string|null
    $help_post

$help_pre


    public
        string|null
    $help_pre

$id


    public
        int|string|null
    $id

$is_active


    public
        bool|string
    $is_active

$is_quick_config


    public
        bool|string
    $is_quick_config

$is_reserved


    public
        bool|string
    $is_reserved

$javascript


    public
        string|null
    $javascript

$min_amount


    public
        float|string|null
    $min_amount

$name


    public
        string
    $name

$title


    public
        string
    $title

$_options

https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings


    protected
        array<string|int, mixed>
    $_options
     = []

$resultCopies

How many times has this instance been cloned.


    protected
        int
    $resultCopies
     = 0

__clone()


    public
                    __clone() : mixed

__construct()

Class constructor.


    public
                    __construct() : static

Return values

static

__destruct()

Class destructor.


    public
                    __destruct() : mixed

acceptedSQLOperators()


    public
            static        acceptedSQLOperators() : array<string|int, string>

Return values

array<string|int, string>

addSelectWhereClause()

Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity


    public
                    addSelectWhereClause([string|null $entityName = NULL ][, int|null $userId = NULL ][, array<string|int, mixed> $conditions = [] ]) : array<string|int, mixed>

Return format is in the form of fieldname => clauses starting with an operator. e.g.:

  [
    // Each string in the array will get joined with AND
    'location_type_id' => ['IS NOT NULL', 'IN (1,2,3)'],
    // Each sub-array in the array will get joined with OR, field names must be enclosed in curly braces
    'privacy' => [
                   ['= 0', '= 1 AND {contact_id} = 456'],
                 ],
  ]

Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values. The query strings MAY reference other fields in this entity; they must be enclosed in {curly_braces}.

Parameters

$entityName : string|null = NULL: Name of the entity being queried (for normal BAO files implementing this method, this variable is redundant as there is a 1-1 relationship between most entities and most BAOs. However the variable is passed in to support dynamic entities such as ECK).
$userId : int|null = NULL: Contact id of the current user. This param is more aspirational than functional for now. Someday the API may support checking permissions for contacts other than the current user, but at present this is always NULL which defaults to the current user.
$conditions : array<string|int, mixed> = []: Contains field/value pairs gleaned from the WHERE clause or ON clause (depending on how the entity was added to the query). Can be used for optimization/deduping of clauses.

Return values

array<string|int, mixed>

addTo()

Link the price set with the specified table and id.


    public
            static        addTo(string $entityTable, int $entityId, int $priceSetId) : bool

Parameters

$entityTable : string
$entityId : int
$priceSetId : int

Return values

bool

appendPseudoConstantsToFields()

Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.


    public
            static        appendPseudoConstantsToFields(array<string|int, mixed> &$fields) : mixed

This is relevant where we want to offer both the ID field and the label field as an option, e.g. search builder.

It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the change small, but is appropriate for other sorts of pseudoconstants.

Parameters

$fields : array<string|int, mixed>

buildOptions()

Legacy field options getter.


    public
            static        buildOptions(string $fieldName[, string $context = NULL ][, array<string|int, mixed> $values = [] ]) : array<string|int, mixed>|bool

in favor of Civi::entity()->getOptions()

Overriding this function is no longer recommended as a way to customize options. Instead, option lists can be customized by either:

Using a pseudoconstant callback
Implementing hook_civicrm_fieldOptions

Parameters

$fieldName : string
$context : string = NULL
$values : array<string|int, mixed> = []: Raw field values; whatever is known about this bao object.

Note: $values can contain unsanitized input and should be handled with care by CRM_Core_PseudoConstant::get

Return values

array<string|int, mixed>|bool

buildOptionsContext()

Provides documentation and validation for the buildOptions $context param


    public
            static        buildOptionsContext([string $context = NULL ]) : array<string|int, mixed>

Parameters

$context : string = NULL

Return values

array<string|int, mixed>

buildPriceSet()

Build the price set form.


    public
            static        buildPriceSet(CRM_Core_Form &$form[, string|null $component = NULL ][, bool $validFieldsOnly = TRUE ]) : void

since 5.68. Will be removed around 5.80.

Parameters

$form : CRM_Core_Form
$component : string|null = NULL
$validFieldsOnly : bool = TRUE

cascadeUpdate()

Cascade update through related entities.


    public
            static        cascadeUpdate(string $daoName, mixed $fromId, mixed $toId[, array<string|int, mixed> $newData = [] ]) : CRM_Core_DAO|null

Parameters

$daoName : string
$fromId : mixed
$toId : mixed
$newData : array<string|int, mixed> = []

Return values

CRM_Core_DAO|null

checkAutoRenewForPriceSet()

Check if auto renew option should be shown.


    public
            static        checkAutoRenewForPriceSet(int $priceSetId) : int

The auto-renew option should be visible if membership types associated with all the fields has been set for auto-renew option.

Auto renew checkbox should be frozen if for all the membership type auto renew is required

Parameters

$priceSetId : int: Price set id.

Return values

int —

$autoRenewOption ( 0:hide, 1:optional 2:required )

checkConstraintExists()

Checks if a constraint exists for a specified table.


    public
            static        checkConstraintExists(string $tableName, string $constraint) : bool

Parameters

$tableName : string
$constraint : string

Return values

bool —

true if constraint exists, false otherwise

checkFieldHasAlwaysValue()

Check whether a specific column in a specific table has always the same value.


    public
            static        checkFieldHasAlwaysValue(mixed $tableName, mixed $columnName, mixed $columnValue) : mixed

in 5.72 will be removed in 5.85

Parameters

$tableName : mixed
$columnName : mixed
$columnValue : mixed

checkFieldIsAlwaysNull()

Check whether a specific column in a specific table is always NULL.


    public
            static        checkFieldIsAlwaysNull(mixed $tableName, mixed $columnName) : mixed

in 5.72 will be removed in 5.85

Parameters

$tableName : mixed
$columnName : mixed

checkFKConstraintInFormat()

Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.


    public
            static        checkFKConstraintInFormat(mixed $tableName, mixed $columnName) : mixed

in 5.72 will be removed in 5.85

Parameters

$tableName : mixed
$columnName : mixed

checkPermission()

check price set permission.


    public
            static        checkPermission(int $sid) : bool

Parameters

$sid : int: The price set id.

Return values

bool

checkTableExists()

Check if there is a given table in the database.


    public
            static        checkTableExists(string $tableName) : bool

Parameters

$tableName : string

Return values

bool —

true if exists, else false

checkTableHasData()

Check if a given table has data.


    public
            static        checkTableHasData(string $tableName) : bool

Parameters

$tableName : string

Return values

bool —

TRUE if $tableName has at least one record.

checkTriggerViewPermission()


    public
            static        checkTriggerViewPermission([bool $view = TRUE ][, bool $trigger = TRUE ]) : bool

Parameters

$view : bool = TRUE
$trigger : bool = TRUE

Return values

bool

commonRetrieveAll()

Fetch object based on array of properties.


    public
            static        commonRetrieveAll(string $daoName, string $fieldIdName, int $fieldId, mixed &$details[, array<string|int, mixed> $returnProperities = NULL ]) : object

Parameters

$daoName : string: Name of the dao object.
$fieldIdName : string
$fieldId : int
$details : mixed
$returnProperities : array<string|int, mixed> = NULL: An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').

Return values

object —

an object of type referenced by daoName

composeQuery()

Compose the query by merging the parameters into it.


    public
            static        composeQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ]) : string

Parameters

$query : string
$params : array<string|int, mixed> = []
$abort : bool = TRUE

Return values

string

copy()

Copy a price set, including all the fields


    public
            static        copy(int $id) : CRM_Price_DAO_PriceSet

Parameters

$id : int: The price set id to copy.

Return values

CRM_Price_DAO_PriceSet

copyCustomFields()

Method that copies custom fields values from an old entity to a new one.


    public
                    copyCustomFields(int $entityID, int $newEntityID[, string $parentOperation = NULL ]) : mixed

Fixes bug CRM-19302, where if a custom field of File type was present, left both events using the same file, breaking download URL's for the old event.

Parameters

$entityID : int
$newEntityID : int
$parentOperation : string = NULL

copyGeneric()

Make a shallow copy of an object and all the fields in the object.


    public
            static        copyGeneric(string $daoName, array<string|int, mixed> $criteria[, array<string|int, mixed> $newData = NULL ][, string $fieldsFix = NULL ][, string $blockCopyOfDependencies = NULL ][, bool $blockCopyofCustomValues = FALSE ]) : CRM_Core_DAO|bool

Parameters

$daoName : string: Name of the dao.
$criteria : array<string|int, mixed>: Array of all the fields & values. on which basis to copy
$newData : array<string|int, mixed> = NULL: Array of all the fields & values. to be copied besides the other fields
$fieldsFix : string = NULL: Array of fields that you want to prefix/suffix/replace.
$blockCopyOfDependencies : string = NULL: Fields that you want to block from. getting copied
$blockCopyofCustomValues : bool = FALSE: Case when you don't want to copy the custom values set in a template as it will override/ignore the submitted custom values

Return values

CRM_Core_DAO|bool —

the newly created copy of the object. False if none created.

copyPriceSet()

Copy priceSet when event/contibution page is copied


    public
            static        copyPriceSet(string $baoName, int $id, int $newId) : mixed

Parameters

$baoName : string: BAO name.
$id : int: Old event/contribution page id.
$newId : int: Newly created event/contribution page id.

copyValues()

Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values


    public
                    copyValues(array<string|int, mixed> $params) : bool

Parameters

$params : array<string|int, mixed>: Array of name/value pairs to save.

Return values

bool —

Did we copy all null values into the object

create()

Takes an associative array and creates a price set object.


    public
            static        create(array<string|int, mixed> $params) : CRM_Price_BAO_PriceSet

Use writeRecord

Parameters

$params : array<string|int, mixed>

Return values

CRM_Price_BAO_PriceSet

createReferenceColumns()

Given a list of fields, create a list of references.


    public
            static        createReferenceColumns(string $className) : array<string|int, CRM_Core_Reference_Interface>

Parameters

$className : string: BAO/DAO class name.

Return values

array<string|int, CRM_Core_Reference_Interface>

createSQLFilter()

Get SQL where clause for SQL filter syntax input parameters.


    public
            static        createSQLFilter(string $fieldName, array<string|int, mixed> $filter[, string $type = NULL ][, string $alias = NULL ][, bool $returnSanitisedArray = FALSE ]) : null|string|array<string|int, mixed>

SQL version of api function to assign filters to the DAO based on the syntax $field => array('IN' => array(4,6,9)) OR $field => array('LIKE' => array('%me%)) etc

Parameters

$fieldName : string: Name of fields.
$filter : array<string|int, mixed>: filter to be applied indexed by operator.
$type : string = NULL: type of field (not actually used - nor in api @todo ).
$alias : string = NULL: alternative field name ('as') @todo- not actually used.
$returnSanitisedArray : bool = FALSE: Return a sanitised array instead of a clause. this is primarily so we can add filters @ the api level to the Query object based fields

Return values

null|string|array<string|int, mixed> —

a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL depending on whether it is supported as yet

createTestObject()

Creates a test object, including any required objects it needs via recursion createOnly: only create in database, do not store or return the objects (useful for perf testing) ONLY USE FOR TESTING


    public
            static        createTestObject(string $daoName[, array<string|int, mixed> $params = [] ][, int $numObjects = 1 ][, bool $createOnly = FALSE ]) : object|array<string|int, mixed>|null

Parameters

$daoName : string
$params : array<string|int, mixed> = []
$numObjects : int = 1
$createOnly : bool = FALSE

Return values

object|array<string|int, mixed>|null —

NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.

createTriggers()


    public
            static        createTriggers(array<string|int, mixed> &$info[, string $onlyTableName = NULL ]) : mixed

Parameters

$info : array<string|int, mixed>: per hook_civicrm_triggerInfo.
$onlyTableName : string = NULL: the specific table requiring a rebuild; or NULL to rebuild all tables.

debugPrint()


    public
            static        debugPrint([null $message = NULL ][, bool $printDAO = TRUE ]) : mixed

Parameters

$message : null = NULL
$printDAO : bool = TRUE

delete()

Deletes items from table which match current objects variables.


    public
                    delete([bool $useWhere = FALSE ]) : int|false

Returns the true on success

for example

Designed to be extended

$object = new mytable(); $object->ID=123; echo $object->delete(); // builds a conditon

$object = new mytable(); $object->whereAdd('age > 12'); $object->limit(1); $object->orderBy('age DESC'); $object->delete(true); // dont use object vars, use the conditions, limit and order.

Parameters

$useWhere : bool = FALSE: (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then we will build the condition only using the whereAdd's. Default is to build the condition only using the object parameters.

Return values

int|false —

Int (No. of rows affected) on success, false on failure, 0 on no data affected

deleteEntityContact()

Unused function.


    public
            static        deleteEntityContact(mixed $daoName, mixed $contactId) : mixed

in 5.47 will be removed in 5.80

Parameters

$daoName : mixed
$contactId : mixed

deleteRecord()

Delete a record from supplied params.


    public
            static        deleteRecord(array<string|int, mixed> $record) : static

Parameters

$record : array<string|int, mixed>: 'id' is required.

Return values

static

deleteRecords()

Bulk delete multiple records.


    public
            static        deleteRecords(array<string|int, array<string|int, mixed>> $records) : array<string|int, static>

Parameters

$records : array<string|int, array<string|int, mixed>>

Return values

array<string|int, static>

deleteSet()

Delete the price set, including the fields.


    public
            static        deleteSet(int $id) : bool

Parameters

$id : int: Price Set id.

Return values

bool —

false if fields exist for this set, true if the set could be deleted

deleteTestObjects()

Deletes the this object plus any dependent objects that are associated with it.


    public
            static        deleteTestObjects(string $daoName[, array<string|int, mixed> $params = [] ]) : mixed

ONLY USE FOR TESTING

Parameters

$daoName : string
$params : array<string|int, mixed> = []

disableFullGroupByMode()

Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary


    public
            static        disableFullGroupByMode() : mixed

dropAllTables()

Drop all CiviCRM tables.


    public
            static        dropAllTables() : mixed

dropTriggers()

Wrapper function to drop triggers.


    public
            static        dropTriggers([string $tableName = NULL ]) : mixed

Parameters

$tableName : string = NULL: the specific table requiring a rebuild; or NULL to rebuild all tables.

escapeString()


    public
            static        escapeString(mixed $string) : string

Parameters

$string : mixed

Return values

string

escapeStrings()

Escape a list of strings for use with "WHERE X IN (...)" queries.


    public
            static        escapeStrings(array<string|int, mixed> $strings[, string $default = NULL ]) : string

Parameters

$strings : array<string|int, mixed>
$default : string = NULL: the value to use if $strings has no elements.

Return values

string —

eg "abc","def","ghi"

escapeWildCardString()


    public
            static        escapeWildCardString(mixed $string) : string

Parameters

$string : mixed

Return values

string

eventPriceSetDomainID()


    public
            static        eventPriceSetDomainID() : object

Return values

object

executeQuery()

Execute a query.


    public
            static    &    executeQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ][, null $daoName = NULL ][, bool $freeDAO = FALSE ][, bool $i18nRewrite = TRUE ][, bool $trapException = FALSE ][, array<string|int, mixed> $options = [] ]) : CRM_Core_DAO|object

Parameters

$query : string: Query to be executed.
$params : array<string|int, mixed> = []
$abort : bool = TRUE
$daoName : null = NULL
$freeDAO : bool = FALSE
$i18nRewrite : bool = TRUE
$trapException : bool = FALSE
$options : array<string|int, mixed> = []

Return values

CRM_Core_DAO|object —

object that holds the results of the query NB - if this is defined as just returning a DAO phpstorm keeps pointing out all the properties that are not part of the DAO

executeUnbufferedQuery()

Execute an unbuffered query.


    public
            static        executeUnbufferedQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ][, null $daoName = NULL ][, bool $freeDAO = FALSE ][, bool $i18nRewrite = TRUE ][, bool $trapException = FALSE ]) : CRM_Core_DAO

This is a wrapper around new functionality exposed with CRM-17748.

Parameters

$query : string: query to be executed
$params : array<string|int, mixed> = []
$abort : bool = TRUE
$daoName : null = NULL
$freeDAO : bool = FALSE
$i18nRewrite : bool = TRUE
$trapException : bool = FALSE

Return values

CRM_Core_DAO —

Object that points to an unbuffered result set

export()

Returns the list of fields that can be exported


    public
            static        export([bool $prefix = FALSE ]) : array<string|int, mixed>

Parameters

$prefix : bool = FALSE

Return values

array<string|int, mixed>

fetchAll()

Returns all results as array-encoded records.


    public
                    fetchAll([mixed $k = FALSE ][, mixed $v = FALSE ][, mixed $method = FALSE ]) : array<string|int, mixed>

Parameters

$k : mixed = FALSE
$v : mixed = FALSE
$method : mixed = FALSE

Return values

array<string|int, mixed>

fetchGenerator()

Return the results as PHP generator.


    public
                    fetchGenerator([string $type = 'dao' ]) : mixed

Parameters

$type : string = 'dao': Whether the generator yields 'dao' objects or 'array's.

fetchMap()

Get all the result records as mapping between columns.


    public
                    fetchMap(string $keyColumn, string $valueColumn) : array<string|int, mixed>

Parameters

$keyColumn : string: Ex: "name"
$valueColumn : string: Ex: "label"

Return values

array<string|int, mixed> —

Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]

fetchValue()

Returns a singular value.


    public
                    fetchValue() : mixed|null

Return values

mixed|null

fieldKeys()

Return a mapping from field-name to the corresponding key (as used in fields()).


    public
            static        fieldKeys() : array<string|int, mixed>

Return values

array<string|int, mixed> —

[string $name => string $uniqueName]

fields()

Returns all the column names of this table.


    public
            static    &    fields() : array<string|int, mixed>

Return values

array<string|int, mixed>

fillValues()

Given an incomplete record, attempt to fill missing field values from the database


    public
            static        fillValues(array<string|int, mixed> $existingValues, mixed $fieldsToRetrieve) : array<string|int, mixed>

Parameters

$existingValues : array<string|int, mixed>
$fieldsToRetrieve : mixed

Return values

array<string|int, mixed>

filterPriceFieldsFromParams()

Get the fields relevant to the price field from the parameters.


    public
            static        filterPriceFieldsFromParams(int $priceSetID, array<string|int, mixed> $params) : array<string|int, mixed>

E.g we are looking for price_5 => 7 out of a big array of input parameters.

Parameters

$priceSetID : int
$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Price fields found in the params array

findById()

Find a DAO object for the given ID and return it.


    public
            static        findById(int $id) : static

Parameters

$id : int: Id of the DAO object being searched for.

Return values

static —

Object of the type of the class that called this function.

findReferences()

Find all records which refer to this entity.


    public
                    findReferences() : array<string|int, CRM_Core_DAO>

Return values

array<string|int, CRM_Core_DAO>

flushPriceSets()


    public
            static        flushPriceSets() : void

formatFieldValues()

Format field values according to fields() metadata.


    public
            static        formatFieldValues(array<string|int, mixed> &$fieldValues) : void

When fetching results from a query, every field is returned as a string. This function automatically converts them to the correct data type.

Parameters

$fieldValues : array<string|int, mixed>

freeResult()


    public
            static        freeResult([null $ids = NULL ]) : mixed

Parameters

$ids : null = NULL

getAmountLevelText()

Get the text to record for amount level.


    public
            static        getAmountLevelText(array<string|int, mixed> $params) : string

Parameters

$params : array<string|int, mixed>

Submitted parameters

priceSetId is required to be set in the calling function (we don't e-notice check it to enforce that - all payments DO have a price set - even if it is the default one & this function asks that be set if it is the case).

Return values

string —

Text for civicrm_contribution.amount_level field.

getAssoc()

Return an associative array of all price sets.


    public
            static        getAssoc([bool $withInactive = FALSE ][, bool|string $extendComponentName = FALSE ][, string $column = 'title' ]) : array<string|int, mixed>

Parameters

$withInactive : bool = FALSE: Whether or not to include inactive entries.
$extendComponentName : bool|string = FALSE: name of the component like 'CiviEvent','CiviContribute'
$column : string = 'title': name of the column.

Return values

array<string|int, mixed> —

associative array of id => name

getAttribute()

Get the size and maxLength attributes for this text field.


    public
            static        getAttribute(string $class[, string $fieldName = NULL ]) : array<string|int, mixed>

(or for all text fields) in the DAO object.

Parameters

$class : string: Name of DAO class.
$fieldName : string = NULL: Field that i'm interested in or null if. you want the attributes for all DAO text fields

Return values

array<string|int, mixed> —

assoc array of name => attribute pairs

getCachedPriceSetDetail()

Get PriceSet + Fields + FieldValues nested, with caching.


    public
            static        getCachedPriceSetDetail(int $priceSetID) : array<string|int, mixed>

This gets the same values as getSet but uses apiv4 for more predictability & better variable typing.

We seem to be passing this array around in a painful way - presumably to avoid the hit of loading it - so lets make it callable with caching.

Parameters

$priceSetID : int

Return values

array<string|int, mixed>

getConnection()


    public
            static        getConnection() : DB_common

Return values

DB_common

getContactIDsFromComponent()

Given the component id, compute the contact id since its used for things like send email


    public
            static        getContactIDsFromComponent(mixed $componentIDs, string $tableName[, string $idField = 'id' ]) : array<string|int, mixed>

Parameters

$componentIDs : mixed
$tableName : string
$idField : string = 'id'

Return values

array<string|int, mixed>

getDatabaseName()

Get the name of the CiviCRM database.


    public
            static        getDatabaseName() : string

use mysql DATABASE() within the query.

Return values

string

getDbVal()

Fetch a single field value from the database.


    public
            static        getDbVal(string $returnColumn, string|int $searchValue[, string $searchColumn = 'id' ]) : array<string|int, mixed>|bool|int|string|null

Uses static caching and applies formatting.

Parameters

$returnColumn : string
$searchValue : string|int
$searchColumn : string = 'id'

Return values

Returned value will be formatted according to data type.

getDefaultFallbackValues()

Callback for `default_fallback` field values


    public
            static        getDefaultFallbackValues(array<string|int, mixed> $record, string $entityName, string $fieldName, array<string|int, mixed> $field) : mixed

Parameters

$record : array<string|int, mixed>
$entityName : string
$fieldName : string
$field : array<string|int, mixed>

getDefaultPriceSet()

Calculate the default price set id assigned to the contribution/membership etc


    public
            static        getDefaultPriceSet([string $entity = 'contribution' ]) : array<string|int, mixed>

Parameters

$entity : string = 'contribution'

Return values

array<string|int, mixed> —

default price set

getDynamicReferencesToTable()

Get all dynamic references to the given table.


    public
            static        getDynamicReferencesToTable(string $tableName) : array<string|int, mixed>

Parameters

$tableName : string

Return values

array<string|int, mixed>

getEntityDescription()

Returns user-friendly description of this entity.


    public
            static        getEntityDescription() : string|null

Return values

string|null

getEntityIcon()

Overridable function to get icon for a particular entity.


    public
            static        getEntityIcon(string $entityName[, int|null $entityId = NULL ]) : string|null

Parameters

$entityName : string: Short name of the entity. This may seem redundant because the entity name can usually be inferred from the BAO class being called, but not always. Some virtual entities share a BAO class.
$entityId : int|null = NULL: Id of the entity.

Return values

string|null

getEntityPaths()

Returns system paths related to this entity (as defined in the xml schema)


    public
            static        getEntityPaths() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntityRefFilters()


    public
            static        getEntityRefFilters() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntityTitle()

Returns localized title of this entity.


    public
            static        getEntityTitle([mixed $plural = FALSE ]) : string

Parameters

$plural : mixed = FALSE

Return values

string

getExportableFieldsWithPseudoConstants()

Get exportable fields with pseudoconstants rendered as an extra field.


    public
            static        getExportableFieldsWithPseudoConstants(string $baoClass) : array<string|int, mixed>

Parameters

$baoClass : string

Return values

array<string|int, mixed>

getExtendsOptions()

Pseudoconstant options for the `extends` field


    public
            static        getExtendsOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

getExtensionName()

Get name of extension in which this DAO is defined.


    public
            static        getExtensionName() : string|null

Return values

string|null

getFieldIds()

Get field ids of a price set.


    public
            static        getFieldIds(int $id) : array<string|int, mixed>

Parameters

$id : int: Price Set id.

Return values

array<string|int, mixed> —

Array of the field ids

getFieldSpec()


    public
                    getFieldSpec(string $fieldName) : bool|array<string|int, mixed>

Parameters

$fieldName : string

Return values

bool|array<string|int, mixed>

getFieldValue()

Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record


    public
            static        getFieldValue(string $daoName, int $searchValue[, string $returnColumn = 'name' ][, string $searchColumn = 'id' ][, bool $force = FALSE ]) : string|int|null

Parameters

$daoName : string: Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
$searchValue : int: Value of the column you want to search by.
$returnColumn : string = 'name': Name of the column you want to GET the value of.
$searchColumn : string = 'id': Name of the column you want to search by.
$force : bool = FALSE: Skip use of the cache.

Return values

string|int|null —

Value of $returnColumn in the retrieved record

getFor()

Find a price_set_id associated with the given table, id and usedFor Used For value for events:1, contribution:2, membership:3


    public
            static        getFor(string $entityTable, int $entityId[, int $usedFor = NULL ][, null $isQuickConfig = NULL ][, null &$setName = NULL ]) : int|false

Parameters

$entityTable : string
$entityId : int
$usedFor : int = NULL: ( price set that extends/used for particular component ).
$isQuickConfig : null = NULL
$setName : null = NULL

Return values

int|false —

price_set_id, or false if none found

getFormsUsingPriceSet()

Get an array of all forms using a given price set.


    public
            static        getFormsUsingPriceSet(int $id) : array<string|int, mixed>

Parameters

$id : int

Return values

array<string|int, mixed> —

Pages using the price set, keyed by type. e.g array(' 'civicrm_contribution_page' => array(2,5,6), 'civicrm_event' => array(5,6), 'civicrm_event_template' => array(7), )

getGlobalSetting()

Lookup the value of a MySQL global configuration variable.


    public
            static        getGlobalSetting(string $name[, mixed $default = NULL ]) : mixed

Parameters

$name : string: E.g. "thread_stack".
$default : mixed = NULL

getLabelField()


    public
            static        getLabelField() : string|null

Return values

string|null

getLine()

Get the relevant line item.


    public
            static        getLine(array<string|int, mixed> &$params, array<string|int, mixed> &$lineItem, int $priceSetID, array<string|int, mixed> $field, int $id) : array<string|int, mixed>

Note this is part of code being cleaned up / refactored & may change.

Parameters

$params : array<string|int, mixed>
$lineItem : array<string|int, mixed>
$priceSetID : int
$field : array<string|int, mixed>
$id : int

Return values

array<string|int, mixed>

getLocaleTableName()

Get localized name of this table, if applicable.


    public
            static        getLocaleTableName([string|null $tableName = NULL ]) : string

If this is a multi-language installation and the table has localized columns, will return table name with language string appended, which points to a sql view. Otherwise, this returns the same output as

Parameters

$tableName : string|null = NULL: Unnecessary deprecated param

Return values

string

getLog()

Returns if this table needs to be logged


    public
                    getLog() : bool

Return values

bool

getMembershipCount()

Return a count of priceFieldValueIDs that are memberships by organisation and membership type


    public
            static        getMembershipCount(string $priceFieldValueIDs) : array<string|int, mixed>

Parameters

$priceFieldValueIDs : string: Comma separated string of priceFieldValue IDs

Return values

array<string|int, mixed> —

Returns an array of counts by membership organisation

getMembershipTypesFromPriceSet()

Get an array of the membership types in a price set.


    public
            static        getMembershipTypesFromPriceSet(int $id) : mixed

Parameters

$id : int

getNonDeductibleAmountFromPriceSet()

Get non-deductible amount from price options


    public
            static        getNonDeductibleAmountFromPriceSet(int $priceSetId, array<string|int, mixed> $lineItem) : int

Parameters

$priceSetId : int
$lineItem : array<string|int, mixed>

Return values

int —

calculated non-deductible amount.

getOnlyPriceFieldID()

Get the Price Field ID.


    public
            static        getOnlyPriceFieldID(array<string|int, mixed> $priceSet) : int

We call this function when more than one being present would represent an error starting format derived from current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))

Parameters

$priceSet : array<string|int, mixed>

Return values

int

getOnlyPriceFieldValueID()

Get the Price Field Value ID. We call this function when more than one being present would represent an error current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))


    public
            static        getOnlyPriceFieldValueID(array<string|int, mixed> $priceSet) : int

Parameters

$priceSet : array<string|int, mixed>

Return values

int

getOptionLabels()

Populate option labels for this object's fields.


    public
                    getOptionLabels() : mixed

getPriceFieldValueFromURL()

Get the value of price field if passed via url


    public
            static        getPriceFieldValueFromURL(CRM_Core_Form &$form, string $priceFieldName) : mixed

Parameters

$form : CRM_Core_Form
$priceFieldName : string

Return values

mixed —

$priceFieldValue

getPricesetCount()

Get the sum of participant count for all fields of given price set.


    public
            static        getPricesetCount(int $sid[, bool $onlyActive = TRUE ]) : int|null|string

Parameters

$sid : int: The price set id.
$onlyActive : bool = TRUE

Return values

int|null|string

getReferenceColumns()

Returns list of FK relationships.


    public
            static        getReferenceColumns() : array<string|int, CRM_Core_Reference_Basic>

Return values

array<string|int, CRM_Core_Reference_Basic>

getReferenceCounts()


    public
                    getReferenceCounts() : array<string|int, array{name: string, type: string, count: int, table: string|null, key: string|null}>

Return values

array<string|int, array{name: string, type: string, count: int, table: string|null, key: string|null}> —

each item has keys:

name: string
type: string
count: int
table: string|null SQL table name
key: string|null SQL column name

getReferencesToContactTable()

Get all references to contact table.


    public
            static        getReferencesToContactTable() : mixed

This includes core tables, custom group tables, tables added by the merge hook and the entity_tag table.

Refer to CRM-17454 for information on the danger of querying the information schema to derive this.

getReferencesToTable()

List all tables which have either: - hard foreign keys to this table, or - a dynamic foreign key that includes this table as a possible target.


    public
            static        getReferencesToTable(string $tableName) : array<string|int, CRM_Core_Reference_Interface>

Parameters

$tableName : string: Table referred to.

Return values

array<string|int, CRM_Core_Reference_Interface> —

structure of table and column, listing every table with a foreign key reference to $tableName, and the column where the key appears.

getSelectWhereClause()

This returns the final permissioned query string for this entity


    public
            static        getSelectWhereClause([string|null $tableAlias = NULL ][, string|null $entityName = NULL ][, array<string|int, mixed> $conditions = [] ]) : array<string|int, mixed>

With acls from related entities + additional clauses from hook_civicrm_selectWhereClause

DO NOT OVERRIDE THIS FUNCTION

Parameters

$tableAlias : string|null = NULL
$entityName : string|null = NULL
$conditions : array<string|int, mixed> = []: Values from WHERE or ON clause

Return values

array<string|int, mixed>

getSetDetail()

Get price set details.


    public
            static        getSetDetail(int $setID[, bool $required = TRUE ][, bool $doNotIncludeExpiredFields = FALSE ]) : array<string|int, mixed>

An array containing price set details (including price fields) is returned

Parameters

$setID : int: Price Set ID.
$required : bool = TRUE: Deprecated.
$doNotIncludeExpiredFields : bool = FALSE: Should only fields where today's date falls within the valid range be returned?

Return values

array<string|int, mixed> —

Array consisting of field details

getSetId()

Find a price_set_id associated with the given option value or field ID.


    public
            static        getSetId(array<string|int, mixed> &$params) : int|null

Parameters

$params : array<string|int, mixed>: (reference) an assoc array of name/value pairs. array may contain either option id or price field id

Return values

int|null —

price set id on success, null otherwise

getSortString()

Unused function.


    public
            static        getSortString(mixed $sort[, mixed $default = NULL ]) : mixed

in 5.72 will be removed in 5.85

Parameters

$sort : mixed
$default : mixed = NULL

getSupportedFields()

Returns all usable fields, indexed by name.


    public
            static        getSupportedFields([bool $checkPermissions = FALSE ]) : array<string|int, mixed>

This function differs from fields() in that it indexes by name rather than unique_name.

It excludes fields not added yet by pending upgrades. This avoids problems with trying to SELECT a field that exists in code but has not yet been added to the db.

Parameters

$checkPermissions : bool = FALSE: Filter by field permissions.

Return values

array<string|int, mixed>

getTableName()

Returns the name of this table


    public
            static        getTableName() : string

Return values

string

getTableNames()

Gets the names of all enabled schema tables.


    public
            static        getTableNames() : array<string|int, mixed>

Includes tables from core, components & enabled extensions.
Excludes log tables, temp tables, and missing/disabled extensions.

Return values

array<string|int, mixed>

getTitle()

Get the price set title.


    public
            static        getTitle(int $id) : string

Parameters

$id : int: Id of price set.

Return values

string —

title

getUsedBy()

Return a list of all forms which use this price set.


    public
            static        getUsedBy(int $id[, bool|string $simpleReturn = FALSE ]) : array<string|int, mixed>

Parameters

$id : int

Id of price set.

$simpleReturn : bool|string = FALSE

get raw data. Possible values: 'entity', 'table'

Return values

array<string|int, mixed>

hook_civicrm_post()


    public
            static        hook_civicrm_post(mixed $op, mixed $objectName, mixed $objectId, mixed &$objectRef) : void

Parameters

$op : mixed
$objectName : mixed
$objectId : mixed
$objectRef : mixed

import()

Returns the list of fields that can be imported


    public
            static        import([bool $prefix = FALSE ]) : array<string|int, mixed>

Parameters

$prefix : bool = FALSE

Return values

array<string|int, mixed>

indices()


    public
            static        indices([bool $localize = TRUE ]) : array<string|int, mixed>

Parameters

$localize : bool = TRUE

Return values

array<string|int, mixed>

init()

Initialize the DAO object.


    public
            static        init(string $dsn) : mixed

Parameters

$dsn : string: The database connection string.

initialize()

Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.


    public
                    initialize() : mixed

isComponentEnabled()

Check if component is enabled for this DAO class


    public
            static        isComponentEnabled() : bool

Return values

bool

isDBMyISAM()


    public
            static        isDBMyISAM([int $maxTablesToCheck = 10 ]) : bool

Parameters

$maxTablesToCheck : int = 10

Return values

bool

isMembershipPriceSetContainsMixOfRenewNonRenew()

Check if price set id provides option for user to select both auto-renew and non-auto-renew memberships


    public
            static        isMembershipPriceSetContainsMixOfRenewNonRenew(int $id) : bool

Parameters

$id : int

Return values

bool

isQuickConfig()

Is the price set 'quick config'.


    public
            static        isQuickConfig(int $priceSetID) : bool

Quick config price sets have a simplified configuration on contribution and event pages.

Parameters

$priceSetID : int

Return values

bool

isValidOption()

Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level


    public
                    isValidOption(array<string|int, mixed> $options) : bool

Parameters

$options : array<string|int, mixed>

Return values

bool —

Provided options are valid

keys()

Returns primary keys (usually ['id'])


    public
                    keys() : array<string|int, string>

Return values

array<string|int, string>

log()


    public
                    log([bool $created = FALSE ]) : mixed

Parameters

$created : bool = FALSE

makeAttribute()

Create an attribute for this specific field. We only do this for strings and text


    public
            static        makeAttribute(array<string|int, mixed> $field) : array<string|int, mixed>|null

Parameters

$field : array<string|int, mixed>: The field under task.

Return values

array<string|int, mixed>|null —

the attributes for the object

objectExists()

Check if there is a record with the same name in the db.


    public
            static        objectExists(string $value, string $daoName, string $daoID[, string $fieldName = 'name' ][, string $domainID = NULL ]) : bool

Parameters

$value : string: The value of the field we are checking.
$daoName : string: The dao object name.
$daoID : string: The id of the object being updated. u can change your name. as long as there is no conflict
$fieldName : string = 'name': The name of the field in the DAO.
$domainID : string = NULL: The id of the domain. Object exists only for the given domain.

Return values

bool —

true if object exists

parseFirstPriceSetValueIDFromParams()

Get the first price set value IDs from a parameters array.


    public
            static        parseFirstPriceSetValueIDFromParams(array<string|int, mixed> $params) : array<string|int, mixed>

In practice this is really used when we only expect one to exist.

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of the ids of the price set values.

parsePriceSetArrayFromParams()

Get the price set value IDs from a set of parameters


    public
            static        parsePriceSetArrayFromParams(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of price fields filtered from the params.

parsePriceSetValueIDsFromParams()

Get the price set value IDs from a set of parameters


    public
            static        parsePriceSetValueIDsFromParams(array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of the ids of the price set values.

processAmount()

Get line item purchase information.


    public
            static        processAmount(mixed $fields, array<string|int, mixed> &$params[, mixed &$lineItem = [] ][, int $priceSetID = NULL ]) : mixed

since 5.69 will be removed around 5.85. This function is still in use but marking deprecated to make it clear that we are moving away from it. There is no function that has the guaranteed stable signature that would allow us to support if from outside of core so if using this or the core alternative from an extension you need to rely on unit tests to keep your code stable. Within core we already have good test cover on code that calls this.

The recommended approach within core is something like

private function initializeOrder(): void { $this->order = new CRM_Financial_BAO_Order(); $this->order->setForm($this); $this->order->setPriceSelectionFromUnfilteredInput($this->>getSubmittedValues()); }

$lineItems = $this->order->getLineItems();

This function takes the input parameters and interprets out of it what has been purchased.

Parameters

$fields : mixed: This is the output of the function CRM_Price_BAO_PriceSet::getSetDetail($priceSetID, FALSE, FALSE); And, it would make sense to introduce caching into that function and call it from here rather than require the $fields array which is passed from pillar to post around the form in order to pass it in here.
$params : array<string|int, mixed>: Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
$lineItem : mixed = []: Line item array to be altered.
$priceSetID : int = NULL

query()

Execute a query by the current DAO, localizing it along the way (if needed).


    public
                    query(string $query[, bool $i18nRewrite = TRUE ]) : object

Parameters

$query : string: The SQL query for execution.
$i18nRewrite : bool = TRUE: Whether to rewrite the query.

Return values

object —

the current DAO object after the query execution

reenableFullGroupByMode()

Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.


    public
            static        reenableFullGroupByMode() : mixed

removeFrom()

Delete price set for the given entity and id.


    public
            static        removeFrom(string $entityTable, int $entityId) : mixed

Parameters

$entityTable : string
$entityId : int

requireSafeDBName()

ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insensitive.


    public
            static        requireSafeDBName(mixed $database) : bool

Parameters

$database : mixed

Return values

bool

reset()

Reset the DAO object.


    public
                    reset() : mixed

DAO is kinda crappy in that there is an unwritten rule of one query per DAO.

We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution

retrieve()


    public
            static        retrieve(array<string|int, mixed> $params, array<string|int, mixed> &$defaults) : self|null

Parameters

$params : array<string|int, mixed>
$defaults : array<string|int, mixed>

Return values

self|null

save()

Save DAO object.


    public
                    save([bool $hook = TRUE ]) : CRM_Core_DAO

Parameters

$hook : bool = TRUE

Return values

CRM_Core_DAO

schemaRequiresRebuilding()

Checks if CONSTRAINT keyword exists for a specified table.


    public
            static        schemaRequiresRebuilding([mixed $tables = ["civicrm_contact"] ]) : mixed

in 5.72 will be removed in 5.85

Parameters

$tables : mixed = ["civicrm_contact"]

self_hook_civicrm_pre()

Event fired before an action is taken on an ACL record.


    public
            static        self_hook_civicrm_pre(PreEvent $event) : mixed

Parameters

$event : PreEvent

sequenceKey()

Tells DB_DataObject which keys use autoincrement.


    public
                    sequenceKey() : array<string|int, mixed>

'id' is autoincrementing by default.

FIXME: this should return all autoincrement keys not just the first.

Return values

array<string|int, mixed>

serializeField()

Transform an array to a serialized string for database storage.


    public
            static        serializeField(array<string|int, mixed>|null $value, int $serializationType) : string|null

Parameters

$value : array<string|int, mixed>|null
$serializationType : int

Return values

string|null

setApiFilter()


    public
                    setApiFilter(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

setCreateDefaults()

Set defaults when creating new entity.


    public
            static        setCreateDefaults(array<string|int, mixed> &$params, mixed $defaults) : mixed

(don't call this set defaults as already in use with different signature in some places)

Parameters

$params : array<string|int, mixed>
$defaults : mixed

setDefaultPriceSet()

Set daefult the price set fields.


    public
            static        setDefaultPriceSet(CRM_Core_Form &$form, mixed &$defaults) : array<string|int, mixed>

Parameters

$form : CRM_Core_Form
$defaults : mixed

Return values

array<string|int, mixed>

setDefaultPriceSetField()

Get the value of price field if passed via url


    public
            static        setDefaultPriceSetField(string $priceFieldName, string $priceFieldValue, string $priceFieldType, array<string|int, mixed> &$defaults) : void

Parameters

$priceFieldName : string
$priceFieldValue : string
$priceFieldType : string
$defaults : array<string|int, mixed>

setFieldValue()

Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record


    public
            static        setFieldValue(string $daoName, int $searchValue, string $setColumn, string $setValue[, string $searchColumn = 'id' ]) : bool

Parameters

$daoName : string: Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
$searchValue : int: Value of the column you want to search by.
$setColumn : string: Name of the column you want to SET the value of.
$setValue : string: SET the setColumn to this value.
$searchColumn : string = 'id': Name of the column you want to search by.

Return values

bool —

true if we found and updated the object, else false

setIsActive()


    public
            static        setIsActive(int $id, bool $isActive) : bool

this bypasses hooks.

Parameters

$id : int
$isActive : bool

Return values

bool

setIsQuickConfig()

Update the is_quick_config flag in the db.


    public
            static        setIsQuickConfig(int $id, bool $isQuickConfig) : bool

Parameters

$id : int: Id of the database record.
$isQuickConfig : bool: we want to set the is_quick_config field. Value we want to set the is_quick_config field.

Return values

bool —

true if we found and updated the object, else false

setLineItem()

Function to set tax_amount and tax_rate in LineItem.


    public
            static        setLineItem(array<string|int, mixed> $field, array<string|int, mixed> $lineItem, int $optionValueId, float &$totalTax) : array<string|int, mixed>

Parameters

$field : array<string|int, mixed>
$lineItem : array<string|int, mixed>
$optionValueId : int
$totalTax : float

Return values

array<string|int, mixed>

setOptions()

https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query


    public
                    setOptions(array<string|int, mixed> $options) : mixed

Parameters

$options : array<string|int, mixed>

setPriceSets()

Supports event create function by setting up required price sets, not tested but expect it will work for contribution page


    public
            static        setPriceSets(array<string|int, mixed> &$params, CRM_Core_DAO $entity, string $entityName) : mixed

Parameters

$params : array<string|int, mixed>: As passed to api/bao create fn.
$entity : CRM_Core_DAO: Object for given entity.
$entityName : string: Name of entity - e.g event.

shortenSQLName()

SQL has a limit of 64 characters on various names: table name, trigger name, column name ... For custom groups and fields we generated names from user entered input which can be longer than this length, this function helps with creating strings that meet various criteria.


    public
            static        shortenSQLName(string $string[, int $length = 60 ][, bool $makeRandom = FALSE ]) : string

Parameters

$string : string: The string to be shortened.
$length : int = 60: The max length of the string.
$makeRandom : bool = FALSE

Return values

string

singleValueQuery()

Execute a query and get the single result.


    public
            static    &    singleValueQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ][, bool $i18nRewrite = TRUE ]) : string|null

Parameters

$query : string: Query to be executed.
$params : array<string|int, mixed> = []
$abort : bool = TRUE
$i18nRewrite : bool = TRUE

Return values

string|null —

the result of the query if any

storeValues()

Store all the values from this object in an associative array this is a destructive store, calling function is responsible for keeping sanity of id's.


    public
            static        storeValues(object &$object, array<string|int, mixed> &$values) : mixed

Parameters

$object : object: The object that we are extracting data from.
$values : array<string|int, mixed>: (reference ) associative array of name/value pairs.

table()

Get/set an associative array of table columns


    public
                    table() : array<string|int, mixed>

Return values

array<string|int, mixed> —

(associative)

tableHasBeenAdded()

Checks if this DAO's table ought to exist.


    public
            static        tableHasBeenAdded() : bool

If there are pending DB updates, this function compares the CiviCRM version of the table to the current schema version.

Return values

bool

triggerRebuild()

Build a list of triggers via hook and add them to (err, reconcile them with) the database.


    public
            static        triggerRebuild([string $tableName = NULL ][, bool $force = FALSE ]) : mixed

Parameters

$tableName : string = NULL: the specific table requiring a rebuild; or NULL to rebuild all tables.
$force : bool = FALSE

unSerializeField()

Transform a serialized string from the database into an array.


    public
            static        unSerializeField(string|null $value, mixed $serializationType) : array<string|int, mixed>|null

Parameters

$value : string|null
$serializationType : mixed

Return values

array<string|int, mixed>|null

writeRecord()

Create or update a record from supplied params.


    public
            static        writeRecord(array<string|int, mixed> $record) : static

If 'id' is supplied, an existing record will be updated Otherwise a new record will be created.

Parameters

$record : array<string|int, mixed>

Return values

static

writeRecords()

Bulk save multiple records


    public
            static        writeRecords(array<string|int, array<string|int, mixed>> $records) : array<string|int, static>

Parameters

$records : array<string|int, array<string|int, mixed>>

Return values

array<string|int, static>

_setDBOptions()

https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level


    protected
                    _setDBOptions(array<string|int, mixed> $options) : mixed

Parameters

$options : array<string|int, mixed>

assignTestFK()


    protected
                    assignTestFK(string $fieldName, mixed $fieldDef, array<string|int, mixed> $params) : mixed

Parameters

$fieldName : string
$fieldDef : mixed
$params : array<string|int, mixed>

assignTestValue()

Generate and assign an arbitrary value to a field of a test object.


    protected
                    assignTestValue(string $fieldName, array<string|int, mixed> &$fieldDef, int $counter) : mixed

Parameters

$fieldName : string
$fieldDef : array<string|int, mixed>
$counter : int: The globally-unique ID of the test object.

copyLocalizable()

Method that copies localizable fields from an old entity to a new one.


    protected
                    copyLocalizable(int $entityID, int $newEntityID, array<string|int, mixed> $fieldsToPrefix, array<string|int, mixed> $fieldsToSuffix, array<string|int, mixed> $fieldsToReplace) : mixed

Fixes bug dev/core#2479, where non current locale fields are copied from current locale losing translation when copying

Parameters

$entityID : int
$newEntityID : int
$fieldsToPrefix : array<string|int, mixed>
$fieldsToSuffix : array<string|int, mixed>
$fieldsToReplace : array<string|int, mixed>

formatFieldValue()

Format a value according to field metadata.


    protected
            static        formatFieldValue(string|null $value, array<string|int, mixed>|null $fieldSpec) : mixed

Parameters

$value : string|null
$fieldSpec : array<string|int, mixed>|null

getDynamicFkAclClauses()

Get an array of ACL clauses for a dynamic FK (entity_id/entity_table combo)


    protected
            static        getDynamicFkAclClauses(string $entityTableField, string $entityIdField[, mixed|null $entityTableValues = NULL ]) : array<string|int, mixed>

Parameters

$entityTableField : string
$entityIdField : string
$entityTableValues : mixed|null = NULL

Return values

array<string|int, mixed>

getFirstPrimaryKey()


    protected
                    getFirstPrimaryKey() : string

Return values

string

getTableAddVersion()


    protected
            static        getTableAddVersion() : string

Return values

string —

Version in which table was added

reformatUsedByFormsWithEntityData()


    protected
            static        reformatUsedByFormsWithEntityData(array<string|int, mixed> $forms) : mixed

Parameters

$forms : array<string|int, mixed>: Array of forms that use a price set keyed by entity. e.g array(' 'civicrm_contribution_page' => array(2,5,6), 'civicrm_event' => array(5,6), 'civicrm_event_template' => array(7), )

Return values

mixed —

Array of entities suppliemented with per entity information. e.g array('civicrm_event' => array(7 => array('title' => 'x'...))

clearDbColumnValueCache()

Remove item from static cache during update/delete operations


    private
                    clearDbColumnValueCache() : mixed

getEntityDefinition()


    private
            static        getEntityDefinition() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntityInfo()


    private
            static        getEntityInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFieldLength()


    private
            static        getFieldLength(mixed $sqlType) : string|null

Parameters

$sqlType : mixed

Return values

string|null

getSchemaFields()


    private
            static        getSchemaFields() : array<string|int, mixed>

Return values

array<string|int, mixed>

loadSchemaFields()


    private
            static        loadSchemaFields() : array<string|int, mixed>

Return values

array<string|int, mixed>

makeNameFromLabel()

When creating a record without a supplied name, create a unique, clean name derived from the label.


    private
                    makeNameFromLabel() : void

Note: this function does nothing unless a unique index exists for "name" column.

setDefaultsFromCallback()

Set default values for fields based on callback functions


    private
            static        setDefaultsFromCallback(string $entityName, array<string|int, mixed> &$record) : void

Parameters

$entityName : string: The entity name
$record : array<string|int, mixed>: The record array to set default values for

CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet in package CRM implements HookInterface

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

BULK_INSERT_COUNT

BULK_INSERT_HIGH_COUNT

DB_DAO_NOTNULL

IS_NULL

NOT_NULL

QUERY_FORMAT_NO_QUOTES

QUERY_FORMAT_WILDCARD

SERIALIZE_COMMA

SERIALIZE_JSON

SERIALIZE_NONE

SERIALIZE_PHP

SERIALIZE_SEPARATOR_BOOKEND

SERIALIZE_SEPARATOR_TRIMMED

VALUE_SEPARATOR

Properties

$_dbColumnValueCache

$_defaultPriceSet

$_icon

$_labelField

$_nullArray

$_nullObject

$_primaryKey

$_testEntitiesToSkip

$domain_id

$extends

$financial_type_id

$help_post

$help_pre

$id

$is_active

$is_quick_config

$is_reserved

$javascript

$min_amount

$name

$title

$_options

$resultCopies

Methods

__clone()

__construct()

Return values

__destruct()

acceptedSQLOperators()

Tags

Return values

addSelectWhereClause()

Parameters

Return values

addTo()

Parameters

Return values

appendPseudoConstantsToFields()

Parameters

buildOptions()

Parameters

Tags

Return values

buildOptionsContext()

Parameters

Tags

Return values

buildPriceSet()

Parameters

cascadeUpdate()

Parameters

Return values

checkAutoRenewForPriceSet()

Parameters

Return values

checkConstraintExists()

Parameters

Tags

CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet
in package

CRM

implements HookInterface