CRM/Price/BAO/PriceSet.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.6                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2015                                |
   7   +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  10   | CiviCRM is free software; you can copy, modify, and distribute it  |
  11   | under the terms of the GNU Affero General Public License           |
  12   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13   |                                                                    |
  14   | CiviCRM is distributed in the hope that it will be useful, but     |
  15   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17   | See the GNU Affero General Public License for more details.        |
  18   |                                                                    |
  19   | You should have received a copy of the GNU Affero General Public   |
  20   | License and the CiviCRM Licensing Exception along                  |
  21   | with this program; if not, contact CiviCRM LLC                     |
  22   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23   | GNU Affero General Public License or the licensing of CiviCRM,     |
  24   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25   +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Business object for managing price sets
  38  *
  39  */
  40 class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet {
  41
  42   /**
  43    * Static field for default price set details.
  44    *
  45    * @var array
  46    */
  47   static $_defaultPriceSet = NULL;
  48
  49   /**
  50    * Class constructor.
  51    */
  52   public function __construct() {
  53     parent::__construct();
  54   }
  55
  56   /**
  57    * Takes an associative array and creates a price set object.
  58    *
  59    * @param array $params
  60    *   (reference) an assoc array of name/value pairs.
  61    *
  62    * @return CRM_Price_DAO_PriceSet
  63    */
  64   public static function create(&$params) {
  65     if (empty($params['id']) && empty($params['name'])) {
  66       $params['name'] = CRM_Utils_String::munge($params['title'], '_', 242);
  67     }
  68     if (!empty($params['extends']) && is_array($params['extends'])) {
  69       $params['extends'] = CRM_Utils_Array::implodePadded($params['extends']);
  70     }
  71     $priceSetBAO = new CRM_Price_BAO_PriceSet();
  72     $priceSetBAO->copyValues($params);
  73     if (self::eventPriceSetDomainID()) {
  74       $priceSetBAO->domain_id = CRM_Core_Config::domainID();
  75     }
  76     return $priceSetBAO->save();
  77   }
  78
  79   /**
  80    * Fetch object based on array of properties.
  81    *
  82    * @param array $params
  83    *   (reference ) an assoc array of name/value pairs.
  84    * @param array $defaults
  85    *   (reference ) an assoc array to hold the flattened values.
  86    *
  87    * @return CRM_Price_DAO_PriceSet
  88    */
  89   public static function retrieve(&$params, &$defaults) {
  90     return CRM_Core_DAO::commonRetrieve('CRM_Price_DAO_PriceSet', $params, $defaults);
  91   }
  92
  93   /**
  94    * Update the is_active flag in the db.
  95    *
  96    * @param int $id
  97    *   Id of the database record.
  98    * @param $isActive
  99    *
 100    * @internal param bool $is_active value we want to set the is_active field
 101    *
 102    * @return Object
 103    *   DAO object on sucess, null otherwise
 104    */
 105   public static function setIsActive($id, $isActive) {
 106     return CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceSet', $id, 'is_active', $isActive);
 107   }
 108
 109   /**
 110    * Calculate the default price set id
 111    * assigned to the contribution/membership etc
 112    *
 113    * @param string $entity
 114    *
 115    * @return array
 116    *   default price set
 117    *
 118    */
 119   public static function getDefaultPriceSet($entity = 'contribution') {
 120     if (!empty(self::$_defaultPriceSet[$entity])) {
 121       return self::$_defaultPriceSet[$entity];
 122     }
 123     $entityName = 'default_contribution_amount';
 124     if ($entity == 'membership') {
 125       $entityName = 'default_membership_type_amount';
 126     }
 127
 128     $sql = "
 129 SELECT      ps.id AS setID, pfv.price_field_id AS priceFieldID, pfv.id AS priceFieldValueID, pfv.name, pfv.label, pfv.membership_type_id, pfv.amount, pfv.financial_type_id
 130 FROM        civicrm_price_set ps
 131 LEFT JOIN   civicrm_price_field pf ON pf.`price_set_id` = ps.id
 132 LEFT JOIN   civicrm_price_field_value pfv ON pfv.price_field_id = pf.id
 133 WHERE       ps.name = '{$entityName}'
 134 ";
 135
 136     $dao = CRM_Core_DAO::executeQuery($sql);
 137     self::$_defaultPriceSet[$entity] = array();
 138     while ($dao->fetch()) {
 139       self::$_defaultPriceSet[$entity][$dao->priceFieldValueID] = array(
 140         'setID' => $dao->setID,
 141         'priceFieldID' => $dao->priceFieldID,
 142         'name' => $dao->name,
 143         'label' => $dao->label,
 144         'priceFieldValueID' => $dao->priceFieldValueID,
 145         'membership_type_id' => $dao->membership_type_id,
 146         'amount' => $dao->amount,
 147         'financial_type_id' => $dao->financial_type_id,
 148       );
 149     }
 150
 151     return self::$_defaultPriceSet[$entity];
 152   }
 153
 154   /**
 155    * Get the price set title.
 156    *
 157    * @param int $id
 158    *   Id of price set.
 159    *
 160    * @return string
 161    *   title
 162    *
 163    */
 164   public static function getTitle($id) {
 165     return CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $id, 'title');
 166   }
 167
 168   /**
 169    * Return a list of all forms which use this price set.
 170    *
 171    * @param int $id
 172    *   Id of price set.
 173    * @param bool|string $simpleReturn - get raw data. Possible values: 'entity', 'table'
 174    *
 175    * @return array
 176    */
 177   public static function &getUsedBy($id, $simpleReturn = FALSE) {
 178     $usedBy = $forms = $tables = array();
 179     $queryString = "
 180 SELECT   entity_table, entity_id
 181 FROM     civicrm_price_set_entity
 182 WHERE    price_set_id = %1";
 183     $params = array(1 => array($id, 'Integer'));
 184     $crmFormDAO = CRM_Core_DAO::executeQuery($queryString, $params);
 185
 186     while ($crmFormDAO->fetch()) {
 187       $forms[$crmFormDAO->entity_table][] = $crmFormDAO->entity_id;
 188       $tables[] = $crmFormDAO->entity_table;
 189     }
 190     // Return only tables
 191     if ($simpleReturn == 'table') {
 192       return $tables;
 193     }
 194     if (empty($forms)) {
 195       $queryString = "
 196 SELECT    cli.entity_table, cli.entity_id
 197 FROM      civicrm_line_item cli
 198 LEFT JOIN civicrm_price_field cpf ON cli.price_field_id = cpf.id
 199 WHERE     cpf.price_set_id = %1";
 200       $params = array(1 => array($id, 'Integer'));
 201       $crmFormDAO = CRM_Core_DAO::executeQuery($queryString, $params);
 202       while ($crmFormDAO->fetch()) {
 203         $forms[$crmFormDAO->entity_table][] = $crmFormDAO->entity_id;
 204         $tables[] = $crmFormDAO->entity_table;
 205       }
 206       if (empty($forms)) {
 207         return $usedBy;
 208       }
 209     }
 210     // Return only entity data
 211     if ($simpleReturn == 'entity') {
 212       return $forms;
 213     }
 214     foreach ($forms as $table => $entities) {
 215       switch ($table) {
 216         case 'civicrm_event':
 217           $ids = implode(',', $entities);
 218           $queryString = "SELECT ce.id as id, ce.title as title, ce.is_public as isPublic, ce.start_date as startDate, ce.end_date as endDate, civicrm_option_value.label as eventType, ce.is_template as isTemplate, ce.template_title as templateTitle
 219 FROM       civicrm_event ce
 220 LEFT JOIN  civicrm_option_value ON
 221            ( ce.event_type_id = civicrm_option_value.value )
 222 LEFT JOIN  civicrm_option_group ON
 223            ( civicrm_option_group.id = civicrm_option_value.option_group_id )
 224 WHERE
 225          civicrm_option_group.name = 'event_type' AND
 226            ce.id IN ($ids) AND
 227            ce.is_active = 1;";
 228           $crmDAO = CRM_Core_DAO::executeQuery($queryString);
 229           while ($crmDAO->fetch()) {
 230             if ($crmDAO->isTemplate) {
 231               $usedBy['civicrm_event_template'][$crmDAO->id]['title'] = $crmDAO->templateTitle;
 232               $usedBy['civicrm_event_template'][$crmDAO->id]['eventType'] = $crmDAO->eventType;
 233               $usedBy['civicrm_event_template'][$crmDAO->id]['isPublic'] = $crmDAO->isPublic;
 234             }
 235             else {
 236               $usedBy[$table][$crmDAO->id]['title'] = $crmDAO->title;
 237               $usedBy[$table][$crmDAO->id]['eventType'] = $crmDAO->eventType;
 238               $usedBy[$table][$crmDAO->id]['startDate'] = $crmDAO->startDate;
 239               $usedBy[$table][$crmDAO->id]['endDate'] = $crmDAO->endDate;
 240               $usedBy[$table][$crmDAO->id]['isPublic'] = $crmDAO->isPublic;
 241             }
 242           }
 243           break;
 244
 245         case 'civicrm_contribution_page':
 246           $ids = implode(',', $entities);
 247           $queryString = "SELECT cp.id as id, cp.title as title, cp.start_date as startDate, cp.end_date as endDate,ct.name as type
 248 FROM      civicrm_contribution_page cp, civicrm_financial_type ct
 249 WHERE     ct.id = cp.financial_type_id AND
 250           cp.id IN ($ids) AND
 251           cp.is_active = 1;";
 252           $crmDAO = CRM_Core_DAO::executeQuery($queryString);
 253           while ($crmDAO->fetch()) {
 254             $usedBy[$table][$crmDAO->id]['title'] = $crmDAO->title;
 255             $usedBy[$table][$crmDAO->id]['type'] = $crmDAO->type;
 256             $usedBy[$table][$crmDAO->id]['startDate'] = $crmDAO->startDate;
 257             $usedBy[$table][$crmDAO->id]['endDate'] = $crmDAO->endDate;
 258           }
 259           break;
 260
 261         case 'civicrm_contribution':
 262         case 'civicrm_membership':
 263         case 'civicrm_participant':
 264           $usedBy[$table] = 1;
 265           break;
 266
 267         default:
 268           CRM_Core_Error::fatal("$table is not supported in PriceSet::usedBy()");
 269           break;
 270       }
 271     }
 272
 273     return $usedBy;
 274   }
 275
 276   /**
 277    * Delete the price set.
 278    *
 279    * @param int $id
 280    *   Price Set id.
 281    *
 282    * @return bool
 283    *   false if fields exist for this set, true if the
 284    *   set could be deleted
 285    *
 286    */
 287   public static function deleteSet($id) {
 288     // remove from all inactive forms
 289     $usedBy = self::getUsedBy($id);
 290     if (isset($usedBy['civicrm_event'])) {
 291       foreach ($usedBy['civicrm_event'] as $eventId => $unused) {
 292         $eventDAO = new CRM_Event_DAO_Event();
 293         $eventDAO->id = $eventId;
 294         $eventDAO->find();
 295         while ($eventDAO->fetch()) {
 296           self::removeFrom('civicrm_event', $eventDAO->id);
 297         }
 298       }
 299     }
 300
 301     // delete price fields
 302     $priceField = new CRM_Price_DAO_PriceField();
 303     $priceField->price_set_id = $id;
 304     $priceField->find();
 305     while ($priceField->fetch()) {
 306       // delete options first
 307       CRM_Price_BAO_PriceField::deleteField($priceField->id);
 308     }
 309
 310     $set = new CRM_Price_DAO_PriceSet();
 311     $set->id = $id;
 312     return $set->delete();
 313   }
 314
 315   /**
 316    * Link the price set with the specified table and id.
 317    *
 318    * @param string $entityTable
 319    * @param int $entityId
 320    * @param int $priceSetId
 321    *
 322    * @return bool
 323    */
 324   public static function addTo($entityTable, $entityId, $priceSetId) {
 325     // verify that the price set exists
 326     $dao = new CRM_Price_DAO_PriceSet();
 327     $dao->id = $priceSetId;
 328     if (!$dao->find()) {
 329       return FALSE;
 330     }
 331     unset($dao);
 332
 333     $dao = new CRM_Price_DAO_PriceSetEntity();
 334     // find if this already exists
 335     $dao->entity_id = $entityId;
 336     $dao->entity_table = $entityTable;
 337     $dao->find(TRUE);
 338
 339     // add or update price_set_id
 340     $dao->price_set_id = $priceSetId;
 341     return $dao->save();
 342   }
 343
 344   /**
 345    * Delete price set for the given entity and id.
 346    *
 347    * @param string $entityTable
 348    * @param int $entityId
 349    *
 350    * @return mixed
 351    */
 352   public static function removeFrom($entityTable, $entityId) {
 353     $dao = new CRM_Price_DAO_PriceSetEntity();
 354     $dao->entity_table = $entityTable;
 355     $dao->entity_id = $entityId;
 356     return $dao->delete();
 357   }
 358
 359   /**
 360    * Find a price_set_id associatied with the given table, id and usedFor
 361    * Used For value for events:1, contribution:2, membership:3
 362    *
 363    * @param string $entityTable
 364    * @param int $entityId
 365    * @param int $usedFor
 366    *   ( price set that extends/used for particular component ).
 367    *
 368    * @param null $isQuickConfig
 369    * @param null $setName
 370    *
 371    * @return int|false
 372    *   price_set_id, or false if none found
 373    */
 374   public static function getFor($entityTable, $entityId, $usedFor = NULL, $isQuickConfig = NULL, &$setName = NULL) {
 375     if (!$entityTable || !$entityId) {
 376       return FALSE;
 377     }
 378
 379     $sql = 'SELECT ps.id as price_set_id, ps.name as price_set_name
 380                 FROM civicrm_price_set ps
 381                 INNER JOIN civicrm_price_set_entity pse ON ps.id = pse.price_set_id
 382                 WHERE pse.entity_table = %1 AND pse.entity_id = %2 ';
 383     if ($isQuickConfig) {
 384       $sql .= ' AND ps.is_quick_config = 0 ';
 385     }
 386     $params = array(
 387       1 => array($entityTable, 'String'),
 388       2 => array($entityId, 'Integer'),
 389     );
 390     if ($usedFor) {
 391       $sql .= " AND ps.extends LIKE '%%3%' ";
 392       $params[3] = array($usedFor, 'Integer');
 393     }
 394
 395     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 396     $dao->fetch();
 397     $setName = (isset($dao->price_set_name)) ? $dao->price_set_name : FALSE;
 398     return (isset($dao->price_set_id)) ? $dao->price_set_id : FALSE;
 399   }
 400
 401   /**
 402    * Find a price_set_id associated with the given option value or  field ID.
 403    *
 404    * @param array $params
 405    *   (reference) an assoc array of name/value pairs.
 406    *                      array may contain either option id or
 407    *                      price field id
 408    *
 409    * @return int|NULL
 410    *   price set id on success, null  otherwise
 411    */
 412   public static function getSetId(&$params) {
 413     $fid = NULL;
 414
 415     if ($oid = CRM_Utils_Array::value('oid', $params)) {
 416       $fieldValue = new CRM_Price_DAO_PriceFieldValue();
 417       $fieldValue->id = $oid;
 418       if ($fieldValue->find(TRUE)) {
 419         $fid = $fieldValue->price_field_id;
 420       }
 421     }
 422     else {
 423       $fid = CRM_Utils_Array::value('fid', $params);
 424     }
 425
 426     if (isset($fid)) {
 427       return CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'price_set_id');
 428     }
 429
 430     return NULL;
 431   }
 432
 433   /**
 434    * Return an associative array of all price sets.
 435    *
 436    * @param bool $withInactive
 437    *   Whether or not to include inactive entries.
 438    * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute'
 439    *
 440    * @return array
 441    *   associative array of id => name
 442    */
 443   public static function getAssoc($withInactive = FALSE, $extendComponentName = FALSE) {
 444     $query = '
 445     SELECT
 446        DISTINCT ( price_set_id ) as id, title
 447     FROM
 448        civicrm_price_field,
 449        civicrm_price_set
 450     WHERE
 451        civicrm_price_set.id = civicrm_price_field.price_set_id  AND is_quick_config = 0 ';
 452
 453     if (!$withInactive) {
 454       $query .= ' AND civicrm_price_set.is_active = 1 ';
 455     }
 456
 457     if (self::eventPriceSetDomainID()) {
 458       $query .= ' AND civicrm_price_set.domain_id = ' . CRM_Core_Config::domainID();
 459     }
 460
 461     $priceSets = array();
 462
 463     if ($extendComponentName) {
 464       $componentId = CRM_Core_Component::getComponentID($extendComponentName);
 465       if (!$componentId) {
 466         return $priceSets;
 467       }
 468       $query .= " AND civicrm_price_set.extends LIKE '%$componentId%' ";
 469     }
 470
 471     $dao = CRM_Core_DAO::executeQuery($query);
 472     while ($dao->fetch()) {
 473       $priceSets[$dao->id] = $dao->title;
 474     }
 475     return $priceSets;
 476   }
 477
 478   /**
 479    * Get price set details.
 480    *
 481    * An array containing price set details (including price fields) is returned
 482    *
 483    * @param int $setID
 484    *   Price Set ID.
 485    * @param bool $required
 486    *   Appears to have no effect based on reading the code.
 487    * @param bool $validOnly
 488    *   Should only fields where today's date falls within the valid range be returned?
 489    *
 490    * @return array
 491    *   Array consisting of field details
 492    */
 493   public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE) {
 494     // create a new tree
 495     $setTree = array();
 496
 497     $priceFields = array(
 498       'id',
 499       'name',
 500       'label',
 501       'html_type',
 502       'is_enter_qty',
 503       'help_pre',
 504       'help_post',
 505       'weight',
 506       'is_display_amounts',
 507       'options_per_line',
 508       'is_active',
 509       'active_on',
 510       'expire_on',
 511       'javascript',
 512       'visibility_id',
 513       'is_required',
 514     );
 515     if ($required == TRUE) {
 516       $priceFields[] = 'is_required';
 517     }
 518
 519     // create select
 520     $select = 'SELECT ' . implode(',', $priceFields);
 521     $from = ' FROM civicrm_price_field';
 522
 523     $params = array();
 524     $params[1] = array($setID, 'Integer');
 525     $where = '
 526 WHERE price_set_id = %1
 527 AND is_active = 1
 528 ';
 529     $dateSelect = '';
 530     if ($validOnly) {
 531       $currentTime = date('YmdHis');
 532       $dateSelect = "
 533 AND ( active_on IS NULL OR active_on <= {$currentTime} )
 534 AND ( expire_on IS NULL OR expire_on >= {$currentTime} )
 535 ";
 536     }
 537
 538     $orderBy = ' ORDER BY weight';
 539
 540     $sql = $select . $from . $where . $dateSelect . $orderBy;
 541
 542     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 543
 544     $visibility = CRM_Core_PseudoConstant::visibility('name');
 545     while ($dao->fetch()) {
 546       $fieldID = $dao->id;
 547
 548       $setTree[$setID]['fields'][$fieldID] = array();
 549       $setTree[$setID]['fields'][$fieldID]['id'] = $fieldID;
 550
 551       foreach ($priceFields as $field) {
 552         if ($field == 'id' || is_null($dao->$field)) {
 553           continue;
 554         }
 555
 556         if ($field == 'visibility_id') {
 557           $setTree[$setID]['fields'][$fieldID]['visibility'] = $visibility[$dao->$field];
 558         }
 559         $setTree[$setID]['fields'][$fieldID][$field] = $dao->$field;
 560       }
 561       $setTree[$setID]['fields'][$fieldID]['options'] = CRM_Price_BAO_PriceField::getOptions($fieldID, FALSE);
 562     }
 563
 564     // also get the pre and post help from this price set
 565     $sql = "
 566 SELECT extends, financial_type_id, help_pre, help_post, is_quick_config
 567 FROM   civicrm_price_set
 568 WHERE  id = %1";
 569     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 570     if ($dao->fetch()) {
 571       $setTree[$setID]['extends'] = $dao->extends;
 572       $setTree[$setID]['financial_type_id'] = $dao->financial_type_id;
 573       $setTree[$setID]['help_pre'] = $dao->help_pre;
 574       $setTree[$setID]['help_post'] = $dao->help_post;
 575       $setTree[$setID]['is_quick_config'] = $dao->is_quick_config;
 576     }
 577     return $setTree;
 578   }
 579
 580   /**
 581    * Get the Price Field ID.
 582    *
 583    * We call this function when more than one being present would represent an error
 584    * starting format derived from current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))
 585    * @param array $priceSet
 586    *
 587    * @throws CRM_Core_Exception
 588    * @return int
 589    */
 590   public static function getOnlyPriceFieldID(array $priceSet) {
 591     if (count($priceSet['fields']) > 1) {
 592       throw new CRM_Core_Exception(ts('expected only one price field to be in priceset but multiple are present'));
 593     }
 594     return (int) implode('_', array_keys($priceSet['fields']));
 595   }
 596
 597   /**
 598    * Get the Price Field Value ID. We call this function when more than one being present would represent an error
 599    * current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))
 600    * @param array $priceSet
 601    *
 602    * @throws CRM_Core_Exception
 603    * @return int
 604    */
 605   public static function getOnlyPriceFieldValueID(array $priceSet) {
 606     $priceFieldID = self::getOnlyPriceFieldID($priceSet);
 607     if (count($priceSet['fields'][$priceFieldID]['options']) > 1) {
 608       throw new CRM_Core_Exception(ts('expected only one price field to be in priceset but multiple are present'));
 609     }
 610     return (int) implode('_', array_keys($priceSet['fields'][$priceFieldID]['options']));
 611   }
 612
 613
 614   /**
 615    * Initiate price set such that various non-BAO things are set on the form.
 616    *
 617    * This function is not really a BAO function so the location is misleading.
 618    *
 619    * @param CRM_Core_Form $form
 620    * @param int $id
 621    *   Form entity id.
 622    * @param string $entityTable
 623    * @param bool $validOnly
 624    * @param int $priceSetId
 625    *   Price Set ID
 626    *
 627    * @return bool|false|int|null
 628    */
 629   public static function initSet(&$form, $id, $entityTable = 'civicrm_event', $validOnly = FALSE, $priceSetId = NULL) {
 630     if (!$priceSetId) {
 631       $priceSetId = self::getFor($entityTable, $id);
 632     }
 633
 634     //check if priceset is is_config
 635     if (is_numeric($priceSetId)) {
 636       if (CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config') && $form->getVar('_name') != 'Participant') {
 637         $form->assign('quickConfig', 1);
 638       }
 639     }
 640     // get price info
 641     if ($priceSetId) {
 642       if ($form->_action & CRM_Core_Action::UPDATE) {
 643         $entityId = $entity = NULL;
 644
 645         switch ($entityTable) {
 646           case 'civicrm_event':
 647             $entity = 'participant';
 648             if (CRM_Utils_System::getClassName($form) == 'CRM_Event_Form_Participant') {
 649               $entityId = $form->_id;
 650             }
 651             else {
 652               $entityId = $form->_participantId;
 653             }
 654             break;
 655
 656           case 'civicrm_contribution_page':
 657           case 'civicrm_contribution':
 658             $entity = 'contribution';
 659             $entityId = $form->_id;
 660             break;
 661         }
 662
 663         if ($entityId && $entity) {
 664           $form->_values['line_items'] = CRM_Price_BAO_LineItem::getLineItems($entityId, $entity);
 665         }
 666         $required = FALSE;
 667       }
 668       else {
 669         $required = TRUE;
 670       }
 671
 672       $form->_priceSetId = $priceSetId;
 673       $priceSet = self::getSetDetail($priceSetId, $required, $validOnly);
 674       $form->_priceSet = CRM_Utils_Array::value($priceSetId, $priceSet);
 675       $form->_values['fee'] = CRM_Utils_Array::value('fields', $form->_priceSet);
 676
 677       //get the price set fields participant count.
 678       if ($entityTable == 'civicrm_event') {
 679         //get option count info.
 680         $form->_priceSet['optionsCountTotal'] = self::getPricesetCount($priceSetId);
 681         if ($form->_priceSet['optionsCountTotal']) {
 682           $optionsCountDeails = array();
 683           if (!empty($form->_priceSet['fields'])) {
 684             foreach ($form->_priceSet['fields'] as $field) {
 685               foreach ($field['options'] as $option) {
 686                 $count = CRM_Utils_Array::value('count', $option, 0);
 687                 $optionsCountDeails['fields'][$field['id']]['options'][$option['id']] = $count;
 688               }
 689             }
 690           }
 691           $form->_priceSet['optionsCountDetails'] = $optionsCountDeails;
 692         }
 693
 694         //get option max value info.
 695         $optionsMaxValueTotal = 0;
 696         $optionsMaxValueDetails = array();
 697
 698         if (!empty($form->_priceSet['fields'])) {
 699           foreach ($form->_priceSet['fields'] as $field) {
 700             foreach ($field['options'] as $option) {
 701               $maxVal = CRM_Utils_Array::value('max_value', $option, 0);
 702               $optionsMaxValueDetails['fields'][$field['id']]['options'][$option['id']] = $maxVal;
 703               $optionsMaxValueTotal += $maxVal;
 704             }
 705           }
 706         }
 707
 708         $form->_priceSet['optionsMaxValueTotal'] = $optionsMaxValueTotal;
 709         if ($optionsMaxValueTotal) {
 710           $form->_priceSet['optionsMaxValueDetails'] = $optionsMaxValueDetails;
 711         }
 712       }
 713       $form->set('priceSetId', $form->_priceSetId);
 714       $form->set('priceSet', $form->_priceSet);
 715
 716       return $priceSetId;
 717     }
 718     return FALSE;
 719   }
 720
 721   /**
 722    * Get line item purchase information.
 723    *
 724    * This function takes the input parameters and interprets out of it what has been purchased.
 725    *
 726    * @param $fields
 727    *   This is the output of the function CRM_Price_BAO_PriceSet::getSetDetail($priceSetID, FALSE, FALSE);
 728    *   And, it would make sense to introduce caching into that function and call it from here rather than
 729    *   require the $fields array which is passed from pillar to post around the form in order to pass it in here.
 730    * @param array $params
 731    *   Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
 732    * @param $lineItem
 733    *   Line item array to be altered.
 734    * @param string $component
 735    *   This parameter appears to only be relevant to determining whether memberships should be auto-renewed.
 736    *   (and is effectively a boolean for 'is_membership' which could be calculated from the line items.)
 737    */
 738   public static function processAmount(&$fields, &$params, &$lineItem, $component = '') {
 739     // using price set
 740     $totalPrice = $totalTax = 0;
 741     $radioLevel = $checkboxLevel = $selectLevel = $textLevel = array();
 742     if ($component) {
 743       $autoRenew = array();
 744       $autoRenew[0] = $autoRenew[1] = $autoRenew[2] = 0;
 745     }
 746     foreach ($fields as $id => $field) {
 747       if (empty($params["price_{$id}"]) ||
 748         (empty($params["price_{$id}"]) && $params["price_{$id}"] == NULL)
 749       ) {
 750         // skip if nothing was submitted for this field
 751         continue;
 752       }
 753
 754       switch ($field['html_type']) {
 755         case 'Text':
 756           $firstOption = reset($field['options']);
 757           $params["price_{$id}"] = array($firstOption['id'] => $params["price_{$id}"]);
 758           CRM_Price_BAO_LineItem::format($id, $params, $field, $lineItem);
 759           if (CRM_Utils_Array::value('tax_rate', $field['options'][key($field['options'])])) {
 760             $lineItem = self::setLineItem($field, $lineItem, key($field['options']));
 761             $totalTax += $field['options'][key($field['options'])]['tax_amount'] * $lineItem[key($field['options'])]['qty'];
 762           }
 763           if (CRM_Utils_Array::value('name', $field['options'][key($field['options'])]) == 'contribution_amount') {
 764             $taxRates = CRM_Core_PseudoConstant::getTaxRates();
 765             if (array_key_exists($params['financial_type_id'], $taxRates)) {
 766               $field['options'][key($field['options'])]['tax_rate'] = $taxRates[$params['financial_type_id']];
 767               $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($field['options'][key($field['options'])]['amount'], $field['options'][key($field['options'])]['tax_rate']);
 768               $field['options'][key($field['options'])]['tax_amount'] = round($taxAmount['tax_amount'], 2);
 769               $lineItem = self::setLineItem($field, $lineItem, key($field['options']));
 770               $totalTax += $field['options'][key($field['options'])]['tax_amount'] * $lineItem[key($field['options'])]['qty'];
 771             }
 772           }
 773           $totalPrice += $lineItem[$firstOption['id']]['line_total'] + CRM_Utils_Array::value('tax_amount', $lineItem[key($field['options'])]);
 774           break;
 775
 776         case 'Radio':
 777           //special case if user select -none-
 778           if ($params["price_{$id}"] <= 0) {
 779             continue;
 780           }
 781           $params["price_{$id}"] = array($params["price_{$id}"] => 1);
 782           $optionValueId = CRM_Utils_Array::key(1, $params["price_{$id}"]);
 783           $optionLabel = CRM_Utils_Array::value('label', $field['options'][$optionValueId]);
 784           $params['amount_priceset_level_radio'] = array();
 785           $params['amount_priceset_level_radio'][$optionValueId] = $optionLabel;
 786           if (isset($radioLevel)) {
 787             $radioLevel = array_merge($radioLevel,
 788               array_keys($params['amount_priceset_level_radio'])
 789             );
 790           }
 791           else {
 792             $radioLevel = array_keys($params['amount_priceset_level_radio']);
 793           }
 794           CRM_Price_BAO_LineItem::format($id, $params, $field, $lineItem);
 795           if (CRM_Utils_Array::value('tax_rate', $field['options'][$optionValueId])) {
 796             $lineItem = self::setLineItem($field, $lineItem, $optionValueId);
 797             $totalTax += $field['options'][$optionValueId]['tax_amount'];
 798             if (CRM_Utils_Array::value('field_title', $lineItem[$optionValueId]) == 'Membership Amount') {
 799               $lineItem[$optionValueId]['line_total'] = $lineItem[$optionValueId]['unit_price'] = CRM_Utils_Rule::cleanMoney($lineItem[$optionValueId]['line_total'] - $lineItem[$optionValueId]['tax_amount']);
 800             }
 801           }
 802           $totalPrice += $lineItem[$optionValueId]['line_total'] + CRM_Utils_Array::value('tax_amount', $lineItem[$optionValueId]);
 803           if (
 804             $component &&
 805             // auto_renew exists and is empty in some workflows, which php treat as a 0
 806             // and hence we explicitly check to see if auto_renew is numeric
 807             isset($lineItem[$optionValueId]['auto_renew']) &&
 808             is_numeric($lineItem[$optionValueId]['auto_renew'])
 809           ) {
 810             $autoRenew[$lineItem[$optionValueId]['auto_renew']] += $lineItem[$optionValueId]['line_total'];
 811           }
 812           break;
 813
 814         case 'Select':
 815           $params["price_{$id}"] = array($params["price_{$id}"] => 1);
 816           $optionValueId = CRM_Utils_Array::key(1, $params["price_{$id}"]);
 817           $optionLabel = $field['options'][$optionValueId]['label'];
 818           $params['amount_priceset_level_select'] = array();
 819           $params['amount_priceset_level_select'][CRM_Utils_Array::key(1, $params["price_{$id}"])] = $optionLabel;
 820           if (isset($selectLevel)) {
 821             $selectLevel = array_merge($selectLevel, array_keys($params['amount_priceset_level_select']));
 822           }
 823           else {
 824             $selectLevel = array_keys($params['amount_priceset_level_select']);
 825           }
 826           CRM_Price_BAO_LineItem::format($id, $params, $field, $lineItem);
 827           if (CRM_Utils_Array::value('tax_rate', $field['options'][$optionValueId])) {
 828             $lineItem = self::setLineItem($field, $lineItem, $optionValueId);
 829             $totalTax += $field['options'][$optionValueId]['tax_amount'];
 830           }
 831           $totalPrice += $lineItem[$optionValueId]['line_total'] + CRM_Utils_Array::value('tax_amount', $lineItem[$optionValueId]);
 832           if (
 833             $component &&
 834             isset($lineItem[$optionValueId]['auto_renew']) &&
 835             is_numeric($lineItem[$optionValueId]['auto_renew'])
 836           ) {
 837             $autoRenew[$lineItem[$optionValueId]['auto_renew']] += $lineItem[$optionValueId]['line_total'];
 838           }
 839           break;
 840
 841         case 'CheckBox':
 842           $params['amount_priceset_level_checkbox'] = $optionIds = array();
 843           foreach ($params["price_{$id}"] as $optionId => $option) {
 844             $optionIds[] = $optionId;
 845             $optionLabel = $field['options'][$optionId]['label'];
 846             $params['amount_priceset_level_checkbox']["{$field['options'][$optionId]['id']}"] = $optionLabel;
 847             if (isset($checkboxLevel)) {
 848               $checkboxLevel = array_unique(array_merge(
 849                   $checkboxLevel,
 850                   array_keys($params['amount_priceset_level_checkbox'])
 851                 )
 852               );
 853             }
 854             else {
 855               $checkboxLevel = array_keys($params['amount_priceset_level_checkbox']);
 856             }
 857           }
 858           CRM_Price_BAO_LineItem::format($id, $params, $field, $lineItem);
 859           foreach ($optionIds as $optionId) {
 860             if (CRM_Utils_Array::value('tax_rate', $field['options'][$optionId])) {
 861               $lineItem = self::setLineItem($field, $lineItem, $optionId);
 862               $totalTax += $field['options'][$optionId]['tax_amount'];
 863             }
 864             $totalPrice += $lineItem[$optionId]['line_total'] + CRM_Utils_Array::value('tax_amount', $lineItem[$optionId]);
 865             if (
 866               $component &&
 867               isset($lineItem[$optionId]['auto_renew']) &&
 868               is_numeric($lineItem[$optionId]['auto_renew'])
 869             ) {
 870               $autoRenew[$lineItem[$optionId]['auto_renew']] += $lineItem[$optionId]['line_total'];
 871             }
 872           }
 873           break;
 874       }
 875     }
 876
 877     $amount_level = array();
 878     $totalParticipant = 0;
 879     if (is_array($lineItem)) {
 880       foreach ($lineItem as $values) {
 881         $totalParticipant += $values['participant_count'];
 882         $amount_level[] = $values['label'] . ' - ' . (float) $values['qty'];
 883       }
 884     }
 885
 886     $displayParticipantCount = '';
 887     if ($totalParticipant > 0) {
 888       $displayParticipantCount = ' Participant Count -' . $totalParticipant;
 889     }
 890     $params['amount_level'] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $amount_level) . $displayParticipantCount . CRM_Core_DAO::VALUE_SEPARATOR;
 891     $params['amount'] = $totalPrice;
 892     $params['tax_amount'] = $totalTax;
 893     if ($component) {
 894       foreach ($autoRenew as $dontCare => $eachAmount) {
 895         if (!$eachAmount) {
 896           unset($autoRenew[$dontCare]);
 897         }
 898       }
 899       if (count($autoRenew) > 1) {
 900         $params['autoRenew'] = $autoRenew;
 901       }
 902     }
 903   }
 904
 905   /**
 906    * Build the price set form.
 907    *
 908    * @param CRM_Core_Form $form
 909    *
 910    * @return void
 911    */
 912   public static function buildPriceSet(&$form) {
 913     $priceSetId = $form->get('priceSetId');
 914     if (!$priceSetId) {
 915       return;
 916     }
 917
 918     $validFieldsOnly = TRUE;
 919     $className = CRM_Utils_System::getClassName($form);
 920     if (in_array($className, array(
 921       'CRM_Contribute_Form_Contribution',
 922       'CRM_Member_Form_Membership',
 923     ))) {
 924       $validFieldsOnly = FALSE;
 925     }
 926
 927     $priceSet = self::getSetDetail($priceSetId, TRUE, $validFieldsOnly);
 928     $form->_priceSet = CRM_Utils_Array::value($priceSetId, $priceSet);
 929     $validPriceFieldIds = array_keys($form->_priceSet['fields']);
 930     $form->_quickConfig = $quickConfig = 0;
 931     if (CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config')) {
 932       $quickConfig = 1;
 933     }
 934
 935     $form->assign('quickConfig', $quickConfig);
 936     if ($className == 'CRM_Contribute_Form_Contribution_Main') {
 937       $form->_quickConfig = $quickConfig;
 938     }
 939     $form->assign('priceSet', $form->_priceSet);
 940
 941     $component = 'contribution';
 942     if ($className == 'CRM_Member_Form_Membership') {
 943       $component = 'membership';
 944     }
 945
 946     if ($className == 'CRM_Contribute_Form_Contribution_Main') {
 947       $feeBlock = &$form->_values['fee'];
 948       if (!empty($form->_useForMember)) {
 949         $component = 'membership';
 950       }
 951     }
 952     else {
 953       $feeBlock = &$form->_priceSet['fields'];
 954     }
 955
 956     // call the hook.
 957     CRM_Utils_Hook::buildAmount($component, $form, $feeBlock);
 958
 959     // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
 960     $adminFieldVisible = FALSE;
 961     if (CRM_Core_Permission::check('administer CiviCRM')) {
 962       $adminFieldVisible = TRUE;
 963     }
 964
 965     foreach ($feeBlock as $id => $field) {
 966       if (CRM_Utils_Array::value('visibility', $field) == 'public' ||
 967         (CRM_Utils_Array::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
 968         !$validFieldsOnly
 969       ) {
 970         $options = CRM_Utils_Array::value('options', $field);
 971         if ($className == 'CRM_Contribute_Form_Contribution_Main' && $component = 'membership') {
 972           $userid = $form->getVar('_membershipContactID');
 973           $checklifetime = self::checkCurrentMembership($options, $userid);
 974           if ($checklifetime) {
 975             $form->assign('ispricelifetime', TRUE);
 976           }
 977         }
 978         if (!is_array($options) || !in_array($id, $validPriceFieldIds)) {
 979           continue;
 980         }
 981         CRM_Price_BAO_PriceField::addQuickFormElement($form,
 982           'price_' . $field['id'],
 983           $field['id'],
 984           FALSE,
 985           CRM_Utils_Array::value('is_required', $field, FALSE),
 986           NULL,
 987           $options
 988         );
 989       }
 990     }
 991   }
 992
 993   /**
 994    * Check the current Membership having end date null.
 995    *
 996    * @param array $options
 997    * @param int $userid
 998    *   Probably actually contact ID.
 999    *
1000    * @return bool
1001    */
1002   public static function checkCurrentMembership(&$options, $userid) {
1003     if (!$userid || empty($options)) {
1004       return FALSE;
1005     }
1006     static $_contact_memberships = array();
1007     $checkLifetime = FALSE;
1008     foreach ($options as $key => $value) {
1009       if (!empty($value['membership_type_id'])) {
1010         if (!isset($_contact_memberships[$userid][$value['membership_type_id']])) {
1011           $_contact_memberships[$userid][$value['membership_type_id']] = CRM_Member_BAO_Membership::getContactMembership($userid, $value['membership_type_id'], FALSE);
1012         }
1013         $currentMembership = $_contact_memberships[$userid][$value['membership_type_id']];
1014         if (!empty($currentMembership) && empty($currentMembership['end_date'])) {
1015           unset($options[$key]);
1016           $checkLifetime = TRUE;
1017         }
1018       }
1019     }
1020     if ($checkLifetime) {
1021       return TRUE;
1022     }
1023     else {
1024       return FALSE;
1025     }
1026   }
1027
1028   /**
1029    * Set daefult the price set fields.
1030    *
1031    * @param CRM_Core_Form $form
1032    * @param $defaults
1033    *
1034    * @return array
1035    */
1036   public static function setDefaultPriceSet(&$form, &$defaults) {
1037     if (!isset($form->_priceSet) || empty($form->_priceSet['fields'])) {
1038       return $defaults;
1039     }
1040
1041     foreach ($form->_priceSet['fields'] as $key => $val) {
1042       foreach ($val['options'] as $keys => $values) {
1043         if ($values['is_default']) {
1044           if ($val['html_type'] == 'CheckBox') {
1045             $defaults["price_{$key}"][$keys] = 1;
1046           }
1047           else {
1048             $defaults["price_{$key}"] = $keys;
1049           }
1050         }
1051       }
1052     }
1053     return $defaults;
1054   }
1055
1056   /**
1057    * Supports event create function by setting up required price sets, not tested but expect
1058    * it will work for contribution page
1059    * @param array $params
1060    *   As passed to api/bao create fn.
1061    * @param CRM_Core_DAO $entity
1062    *   Object for given entity.
1063    * @param string $entityName
1064    *   Name of entity - e.g event.
1065    */
1066   public static function setPriceSets(&$params, $entity, $entityName) {
1067     if (empty($params['price_set_id']) || !is_array($params['price_set_id'])) {
1068       return;
1069     }
1070     // CRM-14069 note that we may as well start by assuming more than one.
1071     // currently the form does not pass in as an array & will be skipped
1072     // test is passing in as an array but I feel the api should have a metadata that allows
1073     // transform of single to array - seems good for managing transitions - in which case all api
1074     // calls that set price_set_id will hit this
1075     // e.g in getfields 'price_set_id' => array('blah', 'bao_type' => 'array') - causing
1076     // all separated values, strings, json half-separated values (in participant we hit this)
1077     // to be converted to json @ api layer
1078     $pse = new CRM_Price_DAO_PriceSetEntity();
1079     $pse->entity_table = 'civicrm_' . $entityName;
1080     $pse->entity_id = $entity->id;
1081     while ($pse->fetch()) {
1082       if (!in_array($pse->price_set_id, $params['price_set_id'])) {
1083         // note an even more aggressive form of this deletion currently happens in event form
1084         // past price sets discounts are made inaccessible by this as the discount_id is set to NULL
1085         // on the participant record
1086         if (CRM_Price_BAO_PriceSet::removeFrom('civicrm_' . $entityName, $entity->id)) {
1087           CRM_Core_BAO_Discount::del($entity->id, 'civicrm_' . $entityName);
1088         }
1089       }
1090     }
1091     foreach ($params['price_set_id'] as $priceSetID) {
1092       CRM_Price_BAO_PriceSet::addTo('civicrm_' . $entityName, $entity->id, $priceSetID);
1093       //@todo - how should we do this - copied from form
1094       //if (!empty($params['price_field_id'])) {
1095       //  $priceSetID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $params['price_field_id'], 'price_set_id');
1096       //  CRM_Price_BAO_PriceSet::setIsQuickConfig($priceSetID, 0);
1097       //}
1098     }
1099   }
1100
1101   /**
1102    * Get field ids of a price set.
1103    *
1104    * @param int $id
1105    *   Price Set id.
1106    *
1107    * @return array
1108    *   Array of the field ids
1109    *
1110    */
1111   public static function getFieldIds($id) {
1112     $priceField = new CRM_Price_DAO_PriceField();
1113     $priceField->price_set_id = $id;
1114     $priceField->find();
1115     while ($priceField->fetch()) {
1116       $var[] = $priceField->id;
1117     }
1118     return $var;
1119   }
1120
1121   /**
1122    * Copy a price set, including all the fields
1123    *
1124    * @param int $id
1125    *   The price set id to copy.
1126    *
1127    * @return CRM_Price_DAO_PriceSet
1128    */
1129   public static function copy($id) {
1130     $maxId = CRM_Core_DAO::singleValueQuery("SELECT max(id) FROM civicrm_price_set");
1131
1132     $title = ts('[Copy id %1]', array(1 => $maxId + 1));
1133     $fieldsFix = array(
1134       'suffix' => array(
1135         'title' => ' ' . $title,
1136         'name' => '__Copy_id_' . ($maxId + 1) . '_',
1137       ),
1138     );
1139
1140     $copy = &CRM_Core_DAO::copyGeneric('CRM_Price_DAO_PriceSet',
1141       array('id' => $id),
1142       NULL,
1143       $fieldsFix
1144     );
1145
1146     //copying all the blocks pertaining to the price set
1147     $copyPriceField = &CRM_Core_DAO::copyGeneric('CRM_Price_DAO_PriceField',
1148       array('price_set_id' => $id),
1149       array('price_set_id' => $copy->id)
1150     );
1151     if (!empty($copyPriceField)) {
1152       $price = array_combine(self::getFieldIds($id), self::getFieldIds($copy->id));
1153
1154       //copy option group and values
1155       foreach ($price as $originalId => $copyId) {
1156         CRM_Core_DAO::copyGeneric('CRM_Price_DAO_PriceFieldValue',
1157           array('price_field_id' => $originalId),
1158           array('price_field_id' => $copyId)
1159         );
1160       }
1161     }
1162     $copy->save();
1163
1164     CRM_Utils_Hook::copy('Set', $copy);
1165     return $copy;
1166   }
1167
1168   /**
1169    * check price set permission.
1170    *
1171    * @param int $sid
1172    *   The price set id.
1173    *
1174    * @return bool
1175    */
1176   public static function checkPermission($sid) {
1177     if ($sid && self::eventPriceSetDomainID()) {
1178       $domain_id = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $sid, 'domain_id', 'id');
1179       if (CRM_Core_Config::domainID() != $domain_id) {
1180         CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
1181       }
1182     }
1183     return TRUE;
1184   }
1185
1186   /**
1187    * Get the sum of participant count
1188    * for all fields of given price set.
1189    *
1190    * @param int $sid
1191    *   The price set id.
1192    *
1193    * @param bool $onlyActive
1194    *
1195    * @return int|null|string
1196    */
1197   public static function getPricesetCount($sid, $onlyActive = TRUE) {
1198     $count = 0;
1199     if (!$sid) {
1200       return $count;
1201     }
1202
1203     $where = NULL;
1204     if ($onlyActive) {
1205       $where = 'AND  value.is_active = 1 AND field.is_active = 1';
1206     }
1207
1208     static $pricesetFieldCount = array();
1209     if (!isset($pricesetFieldCount[$sid])) {
1210       $sql = "
1211     SELECT  sum(value.count) as totalCount
1212       FROM  civicrm_price_field_value  value
1213 INNER JOIN  civicrm_price_field field ON ( field.id = value.price_field_id )
1214 INNER JOIN  civicrm_price_set pset    ON ( pset.id = field.price_set_id )
1215      WHERE  pset.id = %1
1216             $where";
1217
1218       $count = CRM_Core_DAO::singleValueQuery($sql, array(1 => array($sid, 'Positive')));
1219       $pricesetFieldCount[$sid] = ($count) ? $count : 0;
1220     }
1221
1222     return $pricesetFieldCount[$sid];
1223   }
1224
1225   /**
1226    * @param $ids
1227    *
1228    * @return array
1229    */
1230   public static function getMembershipCount($ids) {
1231     $queryString = "
1232 SELECT       count( pfv.id ) AS count, pfv.id AS id
1233 FROM         civicrm_price_field_value pfv
1234 INNER JOIN    civicrm_membership_type mt ON mt.id = pfv.membership_type_id
1235 WHERE        pfv.id IN ( $ids )
1236 GROUP BY     mt.member_of_contact_id";
1237
1238     $crmDAO = CRM_Core_DAO::executeQuery($queryString);
1239     $count = array();
1240
1241     while ($crmDAO->fetch()) {
1242       $count[$crmDAO->id] = $crmDAO->count;
1243     }
1244
1245     return $count;
1246   }
1247
1248   /**
1249    * Check if auto renew option should be shown.
1250    *
1251    * @param int $priceSetId
1252    *   Price set id.
1253    *
1254    * @return int
1255    *   $autoRenewOption ( 0:hide, 1:optional 2:required )
1256    */
1257   public static function checkAutoRenewForPriceSet($priceSetId) {
1258     // auto-renew option should be visible if membership types associated with all the fields has
1259     // been set for auto-renew option
1260     // Auto renew checkbox should be frozen if for all the membership type auto renew is required
1261
1262     // get the membership type auto renew option and check if required or optional
1263     $query = 'SELECT mt.auto_renew, mt.duration_interval, mt.duration_unit
1264             FROM civicrm_price_field_value pfv
1265             INNER JOIN civicrm_membership_type mt ON pfv.membership_type_id = mt.id
1266             INNER JOIN civicrm_price_field pf ON pfv.price_field_id = pf.id
1267             WHERE pf.price_set_id = %1
1268             AND   pf.is_active = 1
1269             AND   pfv.is_active = 1';
1270
1271     $params = array(1 => array($priceSetId, 'Integer'));
1272
1273     $dao = CRM_Core_DAO::executeQuery($query, $params);
1274     $autoRenewOption = 2;
1275     $interval = $unit = array();
1276     while ($dao->fetch()) {
1277       if (!$dao->auto_renew) {
1278         $autoRenewOption = 0;
1279         break;
1280       }
1281       if ($dao->auto_renew == 1) {
1282         $autoRenewOption = 1;
1283       }
1284
1285       $interval[$dao->duration_interval] = $dao->duration_interval;
1286       $unit[$dao->duration_unit] = $dao->duration_unit;
1287     }
1288
1289     if (count($interval) == 1 && count($unit) == 1 && $autoRenewOption > 0) {
1290       return $autoRenewOption;
1291     }
1292     else {
1293       return 0;
1294     }
1295   }
1296
1297   /**
1298    * Retrieve auto renew frequency and interval.
1299    *
1300    * @param int $priceSetId
1301    *   Price set id.
1302    *
1303    * @return array
1304    *   associate array of frequency interval and unit
1305    */
1306   public static function getRecurDetails($priceSetId) {
1307     $query = 'SELECT mt.duration_interval, mt.duration_unit
1308             FROM civicrm_price_field_value pfv
1309             INNER JOIN civicrm_membership_type mt ON pfv.membership_type_id = mt.id
1310             INNER JOIN civicrm_price_field pf ON pfv.price_field_id = pf.id
1311             WHERE pf.price_set_id = %1 LIMIT 1';
1312
1313     $params = array(1 => array($priceSetId, 'Integer'));
1314     $dao = CRM_Core_DAO::executeQuery($query, $params);
1315     $dao->fetch();
1316     return array($dao->duration_interval, $dao->duration_unit);
1317   }
1318
1319   /**
1320    * @return object
1321    */
1322   public static function eventPriceSetDomainID() {
1323     return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
1324       'event_price_set_domain_id',
1325       NULL, FALSE
1326     );
1327   }
1328
1329   /**
1330    * Update the is_quick_config flag in the db.
1331    *
1332    * @param int $id
1333    *   Id of the database record.
1334    * @param bool $isQuickConfig we want to set the is_quick_config field.
1335    *   Value we want to set the is_quick_config field.
1336    *
1337    * @return Object
1338    *   DAO object on sucess, null otherwise
1339    */
1340   public static function setIsQuickConfig($id, $isQuickConfig) {
1341     return CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceSet', $id, 'is_quick_config', $isQuickConfig);
1342   }
1343
1344   /**
1345    * Check if price set id provides option for
1346    * user to select both auto-renew and non-auto-renew memberships
1347    *
1348    * @param int $id
1349    *
1350    * @return bool
1351    */
1352   public static function checkMembershipPriceSet($id) {
1353     $query
1354       = "SELECT      pfv.id, pfv.price_field_id, pfv.name, pfv.membership_type_id, pf.html_type, mt.auto_renew
1355 FROM        civicrm_price_field_value pfv
1356 LEFT JOIN   civicrm_price_field pf ON pf.id = pfv.price_field_id
1357 LEFT JOIN   civicrm_price_set ps ON ps.id = pf.price_set_id
1358 LEFT JOIN   civicrm_membership_type mt ON mt.id = pfv.membership_type_id
1359 WHERE       ps.id = %1
1360 ";
1361
1362     $params = array(1 => array($id, 'Integer'));
1363     $dao = CRM_Core_DAO::executeQuery($query, $params);
1364
1365     $autoRenew = array();
1366     //FIXME: do a comprehensive check of whether
1367     //2 membership types can be selected
1368     //instead of comparing all of them
1369     while ($dao->fetch()) {
1370       //temp fix for #CRM-10370
1371       //if its NULL consider it '0' i.e. 'No auto-renew option'
1372       $daoAutoRenew = $dao->auto_renew;
1373       if ($daoAutoRenew === NULL) {
1374         $daoAutoRenew = 0;
1375       }
1376       if (!empty($autoRenew) && !in_array($daoAutoRenew, $autoRenew)) {
1377         return TRUE;
1378       }
1379       $autoRenew[] = $daoAutoRenew;
1380     }
1381     return FALSE;
1382   }
1383
1384   /**
1385    * Copy priceSet when event/contibution page is copied
1386    *
1387    * @param string $baoName
1388    *   BAO name.
1389    * @param int $id
1390    *   Old event/contribution page id.
1391    * @param int $newId
1392    *   Newly created event/contribution page id.
1393    */
1394   public static function copyPriceSet($baoName, $id, $newId) {
1395     $priceSetId = CRM_Price_BAO_PriceSet::getFor($baoName, $id);
1396     if ($priceSetId) {
1397       $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1398       if ($isQuickConfig) {
1399         $copyPriceSet = CRM_Price_BAO_PriceSet::copy($priceSetId);
1400         CRM_Price_BAO_PriceSet::addTo($baoName, $newId, $copyPriceSet->id);
1401       }
1402       else {
1403         $copyPriceSet = &CRM_Core_DAO::copyGeneric('CRM_Price_DAO_PriceSetEntity',
1404           array(
1405             'entity_id' => $id,
1406             'entity_table' => $baoName,
1407           ),
1408           array('entity_id' => $newId)
1409         );
1410       }
1411       // copy event discount
1412       if ($baoName == 'civicrm_event') {
1413         $discount = CRM_Core_BAO_Discount::getOptionGroup($id, 'civicrm_event');
1414         foreach ($discount as $discountId => $setId) {
1415
1416           $copyPriceSet = &CRM_Price_BAO_PriceSet::copy($setId);
1417
1418           CRM_Core_DAO::copyGeneric(
1419             'CRM_Core_DAO_Discount',
1420             array(
1421               'id' => $discountId,
1422             ),
1423             array(
1424               'entity_id' => $newId,
1425               'price_set_id' => $copyPriceSet->id,
1426             )
1427           );
1428         }
1429       }
1430     }
1431   }
1432
1433   /**
1434    * Function to set tax_amount and tax_rate in LineItem.
1435    *
1436    * @param array $field
1437    * @param array $lineItem
1438    * @param int $optionValueId
1439    *
1440    * @return array
1441    */
1442   public static function setLineItem($field, $lineItem, $optionValueId) {
1443     if ($field['html_type'] == 'Text') {
1444       $taxAmount = $field['options'][$optionValueId]['tax_amount'] * $lineItem[$optionValueId]['qty'];
1445     }
1446     else {
1447       $taxAmount = $field['options'][$optionValueId]['tax_amount'];
1448     }
1449     $taxRate = $field['options'][$optionValueId]['tax_rate'];
1450     $lineItem[$optionValueId]['tax_amount'] = $taxAmount;
1451     $lineItem[$optionValueId]['tax_rate'] = $taxRate;
1452
1453     return $lineItem;
1454   }
1455
1456 }