*
* @param array $params (reference) an assoc array of name/value pairs
*
- * @return object CRM_Price_DAO_LineItem object
+ * @return CRM_Price_DAO_LineItem object
* @access public
* @static
*/
else {
CRM_Utils_Hook::pre('create', 'LineItem', $params['entity_id'], $params);
}
-
+
// unset entity table and entity id in $params
// we never update the entity table and entity id during update mode
if ($id) {
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $defaults (reference ) an assoc array to hold the flattened values
*
- * @return object CRM_Price_BAO_LineItem object
+ * @return CRM_Price_BAO_LineItem object
* @access public
* @static
*/
}
/**
- * @param $entityId
+ * @param int $entityId
* @param $entityTable
*
* @return null|string
return $lineItemTotal;
}
+ /**
+ * Wrapper for line item retrieval when contribution ID is known
+ * @param int $contributionID
+ *
+ * @return array
+ */
+ static function getLineItemsByContributionID($contributionID) {
+ return self::getLineItems($contributionID,'contribution', NULL, TRUE, TRUE, " WHERE contribution_id = " . (int) $contributionID);
+ }
+
/**
* Given a participant id/contribution id,
* return contribution/fee line items
* @param bool $isQtyZero
* @param bool $relatedEntity
*
+ * @param string $overrideWhereClause e.g "WHERE contribution id = 7 " per the getLineItemsByContributionID wrapper.
+ * this function precedes the convenience of the contribution id but since it does quite a bit more than just a db retrieval we need to be able to use it even
+ * when we don't want it's entity-id magix
+ *
* @return array of line items
*/
- static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL , $isQtyZero = TRUE, $relatedEntity = FALSE) {
- $selectClause = $whereClause = $fromClause = NULL;
+ static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL , $isQtyZero = TRUE, $relatedEntity = FALSE, $overrideWhereClause = '') {
+ $whereClause = $fromClause = NULL;
$selectClause = "
SELECT li.id,
li.label,
li.qty,
li.unit_price,
li.line_total,
+ li.entity_table,
+ li.entity_id,
pf.label as field_title,
pf.html_type,
pfv.membership_type_id,
$getTaxDetails = FALSE;
$invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME,'contribution_invoice_settings');
$invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
+ if ($overrideWhereClause) {
+ $whereClause = $overrideWhereClause;
+ }
+
$dao = CRM_Core_DAO::executeQuery("$selectClause $fromClause $whereClause $orderByClause", $params);
while ($dao->fetch()) {
if (!$dao->id) {
'field_title' => $dao->field_title,
'html_type' => $dao->html_type,
'description' => $dao->description,
- 'entity_id' => $entityId,
+ // the entity id seems prone to randomness but not sure if it has a reason - so if we are overriding the Where clause we assume
+ // we also JUST WANT TO KNOW the the entity_id in the DB
+ 'entity_id' => empty($overrideWhereClause) ? $entityId : $dao->entity_id,
+ 'entity_table' => $dao->entity_table,
'contribution_id' => $dao->contribution_id,
'financial_type_id' => $dao->financial_type_id,
'membership_type_id' => $dao->membership_type_id,
* processAmount method
*
* @param int $fid price set field id
- * @param array $params referance to form values
- * @param array $fields referance to array of fields belonging
+ * @param array $params reference to form values
+ * @param array $fields reference to array of fields belonging
* to the price set used for particular event
- * @param array $values referance to the values array(
+ * @param array $values reference to the values array(
this is
* lineItem array)
*
}
/**
- * Function to process price set and line items.
+ * Process price set and line items.
*
- * @param $entityId
+ * @param int $entityId
* @param array $lineItem line item array
* @param object $contributionDetails
* @param string $entityTable entity table
*
* @param bool $update
*
- * @internal param int $contributionId contribution id
- * @internal param \decimal $initAmount amount
* @access public
* @return void
* @static
foreach ($values as $line) {
$line['entity_table'] = $entityTable;
- $line['entity_id'] = $entityId;
- if(!empty($line['membership_type_id'])) {
- $entityTable == 'civicrm_membership';
- $line['contribution_id'] = $contributionDetails->id;
+ if (empty($line['entity_id'])) {
+ $line['entity_id'] = $entityId;
}
- if ($entityTable == 'civicrm_contribution') {
- $line['contribution_id'] = $entityId;
+ if(!empty($line['membership_type_id'])) {
+ $line['entity_table'] = 'civicrm_membership';
}
- else {
- if (!empty($contributionDetails->id)) {
- $line['contribution_id'] = $contributionDetails->id;
+ if (!empty($contributionDetails->id)) {
+ $line['contribution_id'] = $contributionDetails->id;
+ if ($line['entity_table'] == 'civicrm_contribution') {
+ $line['entity_id'] = $contributionDetails->id;
}
}
+
// if financial type is not set and if price field value is NOT NULL
// get financial type id of price field value
if (!empty($line['price_field_value_id']) && empty($line['financial_type_id'])) {
}
/**
- * @param $entityId
+ * @param int $entityId
* @param string $entityTable
* @param $amount
- * @param null $otherParams
+ * @param array $otherParams
*/
public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
if (!$entityId || CRM_Utils_System::isNull($amount))
}
/**
- * Function to build line items array.
+ * Build line items array.
* @param array $params form values
*
* @param string $entityId entity id
* @return void
* @static
*/
- static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution') {
+ static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution', $isRelatedID = FALSE) {
if (!$entityId) {
- $priceSetDetails = CRM_Price_BAO_PriceSet::getDefaultPriceSet();
+ $priceSetDetails = CRM_Price_BAO_PriceSet::getDefaultPriceSet($entityTable);
+ $totalAmount = CRM_Utils_Array::value('total_amount', $params);
+ $financialType = CRM_Utils_Array::value('financial_type_id', $params);
foreach ($priceSetDetails as $values) {
+ if ($entityTable == 'membership') {
+ if ($isRelatedID != $values['membership_type_id']) {
+ continue;
+ }
+ if (!$totalAmount) {
+ $totalAmount = $values['amount'];
+ }
+ $financialType = $values['financial_type_id'];
+ }
$params['line_item'][$values['setID']][$values['priceFieldID']] = array(
'price_field_id' => $values['priceFieldID'],
'price_field_value_id' => $values['priceFieldValueID'],
'label' => $values['label'],
'qty' => 1,
- 'unit_price' => $params['total_amount'],
- 'line_total' => $params['total_amount'],
- 'financial_type_id' => $params['financial_type_id']
+ 'unit_price' => $totalAmount,
+ 'line_total' => $totalAmount,
+ 'financial_type_id' => $financialType,
+ 'membership_type_id' => $values['membership_type_id']
);
+ break;
}
}
else {
$setID = NULL;
$totalEntityId = count($entityId);
foreach ($entityId as $id) {
- $lineItems = CRM_Price_BAO_LineItem::getLineItems($id, $entityTable);
+ $lineItems = CRM_Price_BAO_LineItem::getLineItems($id, $entityTable, NULL, TRUE, $isRelatedID);
foreach ($lineItems as $key => $values) {
if (!$setID && $values['price_field_id']) {
$setID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $values['price_field_id'], 'price_set_id');
projects / civicrm-core.git / blobdiff