CRM_Price_BAO_PriceSet
class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet
Business object for managing price sets.
Constants
NOT_NULL |
|
IS_NULL |
|
DB_DAO_NOTNULL |
|
VALUE_SEPARATOR |
|
BULK_INSERT_COUNT |
|
BULK_INSERT_HIGH_COUNT |
|
QUERY_FORMAT_WILDCARD |
|
QUERY_FORMAT_NO_QUOTES |
|
Properties
static null | $_nullObject | from CRM_Core_DAO | |
static array | $_nullArray | from CRM_Core_DAO | |
static | $_dbColumnValueCache | from CRM_Core_DAO | |
static array | $_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 | from CRM_Core_DAO |
static object | $_factory | The factory class for this application. | from CRM_Core_DAO |
static | $_checkedSqlFunctionsExist | from CRM_Core_DAO | |
protected | $_options | https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings | from CRM_Core_DAO |
static string | $_tableName | Static instance to hold the table name. | from CRM_Price_DAO_PriceSet |
static boolean | $_log | Should CiviCRM log any modifications to this table in the civicrm_log table. | from CRM_Price_DAO_PriceSet |
int | $id | Price Set | from CRM_Price_DAO_PriceSet |
int | $domain_id | Which Domain is this price-set for | from CRM_Price_DAO_PriceSet |
string | $name | Variable name/programmatic handle for this set of price fields. | from CRM_Price_DAO_PriceSet |
string | $title | Displayed title for the Price Set. | from CRM_Price_DAO_PriceSet |
boolean | $is_active | Is this price set active | from CRM_Price_DAO_PriceSet |
text | $help_pre | Description and/or help text to display before fields in form. | from CRM_Price_DAO_PriceSet |
text | $help_post | Description and/or help text to display after fields in form. | from CRM_Price_DAO_PriceSet |
string | $javascript | Optional Javascript script function(s) included on the form with this price_set. Can be used for conditional | from CRM_Price_DAO_PriceSet |
string | $extends | What components are using this price set? | from CRM_Price_DAO_PriceSet |
int | $financial_type_id | FK to Financial Type(for membership price sets only). | from CRM_Price_DAO_PriceSet |
boolean | $is_quick_config | Is set if edited on Contribution or Event Page rather than through Manage Price Sets | from CRM_Price_DAO_PriceSet |
boolean | $is_reserved | Is this a predefined system price set (i.e. it can not be deleted, edited)? | from CRM_Price_DAO_PriceSet |
int | $min_amount | Minimum Amount required for this set. | from CRM_Price_DAO_PriceSet |
static array | $_defaultPriceSet | Static field for default price set details. |
Methods
Class constructor.
Generate and assign an arbitrary value to a field of a test object.
Execute a query by the current DAO, localizing it along the way (if needed).
Static function to set the factory instance for this class.
Factory method to instantiate a new object from a table name.
Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
Returns foreign keys and entity references.
Deletes items from table which match current objects variables.
Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
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.
Create an attribute for this specific field. We only do this for strings and text
Get the size and maxLength attributes for this text field.
Check if there is a record with the same name in the db.
Check if there is a given column in a specific table.
Scans all the tables using a slow query and table name.
Checks if a constraint exists for a specified table.
Checks if CONSTRAINT keyword exists for a specified table.
Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
Check whether a specific column in a specific table has always the same value.
Check whether a specific column in a specific table is always NULL.
Check if there is a given table in the database.
Get all the result records as mapping between columns.
Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
Get sort string.
Fetch object based on array of properties.
Delete the object records that are associated with this contact.
Execute an unbuffered query.
Execute a query.
Execute a query and get the single result.
Compose the query by merging the parameters into it.
make a shallow copy of an object.
Cascade update through related entities.
Given the component id, compute the contact id since its used for things like send email
Fetch object based on array of properties.
Escape a list of strings for use with "WHERE X IN (.
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
Deletes the this object plus any dependent objects that are associated with it.
Set defaults when creating new entity.
No description
No description
Build a list of triggers via hook and add them to (err, reconcile them with) the database.
Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
Given a list of fields, create a list of references.
List all tables which have hard foreign keys to this table.
Lookup the value of a MySQL global configuration variable.
Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
Get options for the called BAO object's field.
Provides documentation and validation for the buildOptions $context param
Get SQL where clause for SQL filter syntax input parameters.
SQL has a limit of 64 characters on various names: table name, trigger name, column name .
https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
This returns the final permissioned query string for this entity
ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insenstive.
Return a mapping from field-name to the corresponding key (as used in fields()).
Returns the list of fields that can be imported
Returns the list of fields that can be exported
Takes an associative array and creates a price set object.
Fetch object based on array of properties.
Update the is_active flag in the db.
Calculate the default price set id assigned to the contribution/membership etc
Get the price set title.
Return a list of all forms which use this price set.
Delete the price set, including the fields.
Link the price set with the specified table and id.
Delete price set for the given entity and id.
Find a price_set_id associated with the given table, id and usedFor Used For value for events:1, contribution:2, membership:3
Find a price_set_id associated with the given option value or field ID.
Return an associative array of all price sets.
Get price set details.
Get the Price Field ID.
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))
Initiate price set such that various non-BAO things are set on the form.
Get line item purchase information.
Get the text to record for amount level.
Get the fields relevant to the price field from the parameters.
Wrapper for getSetDetail with caching.
Check the current Membership having end date null.
Get the value of price field if passed via url
Get the value of price field if passed via url
Supports event create function by setting up required price sets, not tested but expect it will work for contribution page
Get field ids of a price set.
Copy a price set, including all the fields
check price set permission.
Get the sum of participant count for all fields of given price set.
No description
Check if auto renew option should be shown.
Retrieve auto renew frequency and interval.
No description
Update the is_quick_config flag in the db.
Check if price set id provides option for user to select both auto-renew and non-auto-renew memberships
Get an array of the membership types in a price set.
Copy priceSet when event/contibution page is copied
Function to set tax_amount and tax_rate in LineItem.
Get the first price set value IDs from a parameters array.
Get the price set value IDs from a set of parameters
Get the price set value IDs from a set of parameters
Get non-deductible amount from price options
Get an array of all forms using a given price set.
No description
Details
at line 50
CRM_Core_DAO
__construct()
Class constructor.
in CRM_Price_DAO_PriceSet at line 384
static
getTableName()
Returns the names of this table
in CRM_Core_DAO at line 112
static
init(string $dsn)
Initialize the DAO object.
in CRM_Core_DAO at line 131
static DB_common
getConnection()
in CRM_Core_DAO at line 142
protected
assignTestFK(string $fieldName, $fieldDef, array $params)
in CRM_Core_DAO at line 191
protected
assignTestValue(string $fieldName, array $fieldDef, int $counter)
Generate and assign an arbitrary value to a field of a test object.
in CRM_Core_DAO at line 303
reset()
Reset the DAO object.
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
in CRM_Core_DAO at line 323
static string
getLocaleTableName(string $tableName)
in CRM_Core_DAO at line 345
object
query(string $query, bool $i18nRewrite = TRUE)
Execute a query by the current DAO, localizing it along the way (if needed).
in CRM_Core_DAO at line 374
static
setFactory(object $factory)
Static function to set the factory instance for this class.
in CRM_Core_DAO at line 383
factory(string $table = '')
Factory method to instantiate a new object from a table name.
in CRM_Core_DAO at line 395
initialize()
Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
in CRM_Core_DAO at line 411
array
keys()
Defines the default key as 'id'.
in CRM_Core_DAO at line 426
array
sequenceKey()
Tells DB_DataObject which keys use autoincrement.
'id' is autoincrementing by default.
in CRM_Price_DAO_PriceSet at line 144
static array
getReferenceColumns()
Returns foreign keys and entity references.
in CRM_Price_DAO_PriceSet at line 158
static array
fields()
Returns all the column names of this table
in CRM_Core_DAO at line 462
array
table()
Get/set an associative array of table columns
in CRM_Core_DAO at line 485
CRM_Core_DAO
save(bool $hook = TRUE)
Save DAO object.
in CRM_Core_DAO at line 536
delete(bool $useWhere = FALSE)
Deletes items from table which match current objects variables.
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.
in CRM_Core_DAO at line 552
log(bool $created = FALSE)
in CRM_Core_DAO at line 587
bool
copyValues(array $params)
Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
in CRM_Core_DAO at line 628
static
storeValues(object $object, array $values)
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.
in CRM_Core_DAO at line 650
static array|null
makeAttribute(array $field)
Create an attribute for this specific field. We only do this for strings and text
in CRM_Core_DAO at line 703
static array
getAttribute(string $class, string $fieldName = NULL)
Get the size and maxLength attributes for this text field.
(or for all text fields) in the DAO object.
in CRM_Core_DAO at line 731
static
transaction($type)
in CRM_Core_DAO at line 754
static bool
objectExists(string $value, string $daoName, string $daoID, string $fieldName = 'name', string $domainID = NULL)
Check if there is a record with the same name in the db.
in CRM_Core_DAO at line 780
static bool
checkFieldExists(string $tableName, string $columnName, bool $i18nRewrite = TRUE)
Check if there is a given column in a specific table.
in CRM_Core_DAO at line 798
static array
getTableNames()
Scans all the tables using a slow query and table name.
in CRM_Core_DAO at line 820
static bool
isDBMyISAM(int $maxTablesToCheck = 10)
in CRM_Core_DAO at line 837
static string
getDatabaseName()
Get the name of the CiviCRM database.
in CRM_Core_DAO at line 851
static bool
checkConstraintExists(string $tableName, string $constraint)
Checks if a constraint exists for a specified table.
in CRM_Core_DAO at line 879
static bool
schemaRequiresRebuilding(array $tables = array("civicrm_contact"))
Checks if CONSTRAINT keyword exists for a specified table.
in CRM_Core_DAO at line 915
static bool
checkFKConstraintInFormat(string $tableName, string $columnName)
Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
in CRM_Core_DAO at line 944
static bool
checkFieldHasAlwaysValue(string $tableName, string $columnName, string $columnValue)
Check whether a specific column in a specific table has always the same value.
in CRM_Core_DAO at line 961
static bool
checkFieldIsAlwaysNull(string $tableName, string $columnName)
Check whether a specific column in a specific table is always NULL.
in CRM_Core_DAO at line 977
static bool
checkTableExists(string $tableName)
Check if there is a given table in the database.
in CRM_Core_DAO at line 995
bool
checkVersion($version)
in CRM_Core_DAO at line 1013
static object
findById(int $id)
Find a DAO object for the given ID and return it.
in CRM_Core_DAO at line 1027
array
fetchAll()
Returns all results as array-encoded records.
in CRM_Core_DAO at line 1045
array
fetchMap(string $keyColumn, string $valueColumn)
Get all the result records as mapping between columns.
in CRM_Core_DAO at line 1070
static string|null
getFieldValue(string $daoName, int $searchValue, string $returnColumn = 'name', string $searchColumn = 'id', bool $force = FALSE)
Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
in CRM_Core_DAO at line 1120
static bool
setFieldValue(string $daoName, int $searchValue, string $setColumn, string $setValue, string $searchColumn = 'id')
Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
in CRM_Core_DAO at line 1146
static string
getSortString(array|object $sort, string $default = NULL)
Get sort string.
in CRM_Core_DAO at line 1177
static object
commonRetrieve(string $daoName, array $params, array $defaults, array $returnProperities = NULL)
Fetch object based on array of properties.
in CRM_Core_DAO at line 1202
static
deleteEntityContact(string $daoName, int $contactId)
Delete the object records that are associated with this contact.
in CRM_Core_DAO at line 1227
static CRM_Core_DAO
executeUnbufferedQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)
Execute an unbuffered query.
This is a wrapper around new functionality exposed with CRM-17748.
in CRM_Core_DAO at line 1293
static CRM_Core_DAO|object
executeQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)
Execute a query.
in CRM_Core_DAO at line 1343
static string|null
singleValueQuery(string $query, array $params = array(), bool $abort = TRUE, bool $i18nRewrite = TRUE)
Execute a query and get the single result.
in CRM_Core_DAO at line 1381
static string
composeQuery(string $query, array $params, bool $abort = TRUE)
Compose the query by merging the parameters into it.
in CRM_Core_DAO at line 1428
static
freeResult(null $ids = NULL)
in CRM_Core_DAO at line 1474
static CRM_Core_DAO
copyGeneric(string $daoName, array $criteria, array $newData = NULL, string $fieldsFix = NULL, string $blockCopyOfDependencies = NULL)
make a shallow copy of an object.
and all the fields in the object
in CRM_Core_DAO at line 1557
static CRM_Core_DAO|null
cascadeUpdate(string $daoName, $fromId, $toId, array $newData = array())
Cascade update through related entities.
in CRM_Core_DAO at line 1601
static array
getContactIDsFromComponent($componentIDs, string $tableName)
Given the component id, compute the contact id since its used for things like send email
in CRM_Core_DAO at line 1636
static object
commonRetrieveAll(string $daoName, string $fieldIdName = 'id', int $fieldId, $details, array $returnProperities = NULL)
Fetch object based on array of properties.
in CRM_Core_DAO at line 1658
static
dropAllTables()
in CRM_Core_DAO at line 1680
static string
escapeString($string)
in CRM_Core_DAO at line 1709
static string
escapeStrings(array $strings, string $default = NULL)
Escape a list of strings for use with "WHERE X IN (.
..)" queries.
in CRM_Core_DAO at line 1728
static string
escapeWildCardString($string)
in CRM_Core_DAO at line 1756
static object|array|NULL
createTestObject(string $daoName, array $params = array(), int $numObjects = 1, bool $createOnly = FALSE)
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
in CRM_Core_DAO at line 1839
static
deleteTestObjects(string $daoName, array $params = array())
Deletes the this object plus any dependent objects that are associated with it.
ONLY USE FOR TESTING
in CRM_Core_DAO at line 1885
static
setCreateDefaults(array $params, $defaults)
Set defaults when creating new entity.
(don't call this set defaults as already in use with different signature in some places)
in CRM_Core_DAO at line 1903
static string
createTempTableName(string $prefix = 'civicrm', bool $addRandomString = TRUE, null $string = NULL)
in CRM_Core_DAO at line 1923
static bool
checkTriggerViewPermission(bool $view = TRUE, bool $trigger = TRUE)
in CRM_Core_DAO at line 1971
static
debugPrint(null $message = NULL, bool $printDAO = TRUE)
in CRM_Core_DAO at line 1995
static
triggerRebuild(string $tableName = NULL, bool $force = FALSE)
deprecated
deprecated
Build a list of triggers via hook and add them to (err, reconcile them with) the database.
in CRM_Core_DAO at line 2006
static
checkSqlFunctionsExist()
Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
in CRM_Core_DAO at line 2023
static
dropTriggers(string $tableName = NULL)
deprecated
deprecated
Wrapper function to drop triggers.
in CRM_Core_DAO at line 2034
static
createTriggers(array $info, string $onlyTableName = NULL)
deprecated
deprecated
in CRM_Core_DAO at line 2045
static array
createReferenceColumns(string $className)
Given a list of fields, create a list of references.
in CRM_Core_DAO at line 2068
array
findReferences()
Find all records which refer to this entity.
in CRM_Core_DAO at line 2097
array
getReferenceCounts()
in CRM_Core_DAO at line 2134
static array
getReferencesToTable(string $tableName)
List all tables which have hard foreign keys to this table.
For now, this returns a description of every entity_id/entity_table reference. TODO: filter dynamic entity references on the $tableName, based on schema metadata in dynamicForeignKey which enumerates a restricted set of possible entity_table's.
in CRM_Core_DAO at line 2158
static mixed
getGlobalSetting(string $name, mixed $default = NULL)
Lookup the value of a MySQL global configuration variable.
in CRM_Core_DAO at line 2183
static protected
appendPseudoConstantsToFields(array $fields)
Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
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 for purposes keeping the scope of the change small, but is appropriate for other sorts of pseudoconstants.
in CRM_Core_DAO at line 2209
static array|bool
buildOptions(string $fieldName, string $context = NULL, array $props = array())
Get options for the called BAO object's field.
This function can be overridden by each BAO to add more logic related to context. The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
in CRM_Core_DAO at line 2220
getOptionLabels()
Populate option labels for this object's fields.
in CRM_Core_DAO at line 2246
static array
buildOptionsContext(string $context = NULL)
Provides documentation and validation for the buildOptions $context param
in CRM_Core_DAO at line 2266
bool|array
getFieldSpec(string $fieldName)
in CRM_Core_DAO at line 2309
static NULL|string|array
createSQLFilter(string $fieldName, array $filter, string $type = NULL, string $alias = NULL, bool $returnSanitisedArray = FALSE)
Get SQL where clause for SQL filter syntax input parameters.
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
in CRM_Core_DAO at line 2372
static array
acceptedSQLOperators()
in CRM_Core_DAO at line 2409
static string
shortenSQLName(string $string, int $length = 60, bool $makeRandom = FALSE)
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.
in CRM_Core_DAO at line 2435
setOptions(array $options)
https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
in CRM_Core_DAO at line 2448
protected
_setDBOptions(array $options)
https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
in CRM_Core_DAO at line 2463
setApiFilter(array $params)
deprecated
deprecated
in CRM_Core_DAO at line 2480
array
addSelectWhereClause()
Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
Return format is in the form of fieldname => clauses starting with an operator. e.g.:
in CRM_Core_DAO at line 2521
static array
getSelectWhereClause(string $tableAlias = NULL)
This returns the final permissioned query string for this entity
With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
in CRM_Core_DAO at line 2544
static bool
requireSafeDBName($database)
ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insenstive.
in CRM_Price_DAO_PriceSet at line 373
static array
fieldKeys()
Return a mapping from field-name to the corresponding key (as used in fields()).
in CRM_Price_DAO_PriceSet at line 392
boolean
getLog()
Returns if this table needs to be logged
in CRM_Price_DAO_PriceSet at line 402
static array
import(bool $prefix = false)
Returns the list of fields that can be imported
in CRM_Price_DAO_PriceSet at line 413
static array
export(bool $prefix = false)
Returns the list of fields that can be exported
in CRM_Price_DAO_PriceSet at line 420
static
indices($localize = TRUE)
Returns the list of indices
at line 62
static CRM_Price_DAO_PriceSet
create(array $params)
Takes an associative array and creates a price set object.
at line 97
static CRM_Price_DAO_PriceSet
retrieve(array $params, array $defaults)
Fetch object based on array of properties.
at line 113
static Object
setIsActive(int $id, $isActive)
Update the is_active flag in the db.
at line 127
static array
getDefaultPriceSet(string $entity = 'contribution')
Calculate the default price set id assigned to the contribution/membership etc
at line 172
static string
getTitle(int $id)
Get the price set title.
at line 185
static array
getUsedBy(int $id, bool|string $simpleReturn = FALSE)
Return a list of all forms which use this price set.
at line 232
static bool
deleteSet(int $id)
Delete the price set, including the fields.
at line 256
static bool
addTo(string $entityTable, int $entityId, int $priceSetId)
Link the price set with the specified table and id.
at line 284
static mixed
removeFrom(string $entityTable, int $entityId)
Delete price set for the given entity and id.
at line 306
static int|false
getFor(string $entityTable, int $entityId, int $usedFor = NULL, null $isQuickConfig = NULL, null $setName = NULL)
Find a price_set_id associated with the given table, id and usedFor Used For value for events:1, contribution:2, membership:3
at line 344
static int|NULL
getSetId(array $params)
Find a price_set_id associated with the given option value or field ID.
at line 376
static array
getAssoc(bool $withInactive = FALSE, bool|string $extendComponentName = FALSE, string $column = 'title')
Return an associative array of all price sets.
at line 437
static array
getSetDetail(int $setID, bool $required = TRUE, bool $validOnly = FALSE)
Get price set details.
An array containing price set details (including price fields) is returned
at line 541
static int
getOnlyPriceFieldID(array $priceSet)
Get the Price Field ID.
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))
at line 556
static int
getOnlyPriceFieldValueID(array $priceSet)
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))
at line 580
static bool|false|int|null
initSet(CRM_Core_Form $form, int $id, string $entityTable = 'civicrm_event', bool $validOnly = FALSE, int $priceSetId = NULL)
Initiate price set such that various non-BAO things are set on the form.
This function is not really a BAO function so the location is misleading.
at line 690
static
processAmount($fields, array $params, $lineItem, string $component = '', int $priceSetID = NULL)
Get line item purchase information.
This function takes the input parameters and interprets out of it what has been purchased.
at line 869
static string
getAmountLevelText(array $params)
Get the text to record for amount level.
at line 904
static array
filterPriceFieldsFromParams(int $priceSetID, array $params)
Get the fields relevant to the price field from the parameters.
E.g we are looking for price_5 => 7 out of a big array of input parameters.
at line 930
static array
getCachedPriceSetDetail(int $priceSetID)
Wrapper for getSetDetail with caching.
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.
Why not just add caching to the other function? We could do - it just seemed a bit unclear the best caching pattern & the function was already pretty fugly. Also, I feel like we need to migrate the interaction with price-sets into a more granular interaction - ie. retrieve specific data using specific functions on this class & have the form think less about the price sets.
at line 949
static void
buildPriceSet(CRM_Core_Form $form)
Build the price set form.
at line 1075
static bool
checkCurrentMembership(array $options, int $userid)
Check the current Membership having end date null.
at line 1109
static array
setDefaultPriceSet(CRM_Core_Form $form, $defaults)
Set daefult the price set fields.
at line 1144
static void
setDefaultPriceSetField(string $priceFieldName, string $priceFieldValue, string $priceFieldType, array $defaults)
Get the value of price field if passed via url
at line 1161
static mixed
getPriceFieldValueFromURL(CRM_Core_Form $form, string $priceFieldName)
Get the value of price field if passed via url
at line 1178
static
setPriceSets(array $params, CRM_Core_DAO $entity, string $entityName)
Supports event create function by setting up required price sets, not tested but expect it will work for contribution page
at line 1223
static array
getFieldIds(int $id)
Get field ids of a price set.
at line 1241
static CRM_Price_DAO_PriceSet
copy(int $id)
Copy a price set, including all the fields
at line 1288
static bool
checkPermission(int $sid)
check price set permission.
at line 1309
static int|null|string
getPricesetCount(int $sid, bool $onlyActive = TRUE)
Get the sum of participant count for all fields of given price set.
at line 1342
static array
getMembershipCount($ids)
at line 1374
static int
checkAutoRenewForPriceSet(int $priceSetId)
Check if auto renew option should be shown.
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
at line 1432
static array
getRecurDetails(int $priceSetId)
Retrieve auto renew frequency and interval.
at line 1448
static object
eventPriceSetDomainID()
at line 1463
static Object
setIsQuickConfig(int $id, bool $isQuickConfig)
Update the is_quick_config flag in the db.
at line 1474
static bool
isMembershipPriceSetContainsMixOfRenewNonRenew(int $id)
Check if price set id provides option for user to select both auto-renew and non-auto-renew memberships
at line 1490
static array(
getMembershipTypesFromPriceSet(int $id)
Get an array of the membership types in a price set.
at line 1540
static
copyPriceSet(string $baoName, int $id, int $newId)
Copy priceSet when event/contibution page is copied
at line 1589
static array
setLineItem(array $field, array $lineItem, int $optionValueId, float $totalTax)
Function to set tax_amount and tax_rate in LineItem.
at line 1614
static array
parseFirstPriceSetValueIDFromParams(array $params)
Get the first price set value IDs from a parameters array.
In practice this is really used when we only expect one to exist.
at line 1627
static array
parsePriceSetValueIDsFromParams(array $params)
Get the price set value IDs from a set of parameters
at line 1646
static array
parsePriceSetArrayFromParams(array $params)
Get the price set value IDs from a set of parameters
at line 1666
static int
getNonDeductibleAmountFromPriceSet(int $priceSetId, array $lineItem)
Get non-deductible amount from price options
at line 1690
static array
getFormsUsingPriceSet(int $id)
Get an array of all forms using a given price set.