CRM/Member/BAO/MembershipPayment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  * $Id$
  33  *
  34  */
  35 class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment {
  36
  37   /**
  38    * Class constructor.
  39    */
  40   public function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Add the membership Payments.
  46    *
  47    * @param array $params
  48    *   Reference array contains the values submitted by the form.
  49    *
  50    *
  51    * @return object
  52    */
  53   public static function create($params) {
  54     $hook = empty($params['id']) ? 'create' : 'edit';
  55     CRM_Utils_Hook::pre($hook, 'MembershipPayment', CRM_Utils_Array::value('id', $params), $params);
  56     $dao = new CRM_Member_DAO_MembershipPayment();
  57     $dao->copyValues($params);
  58     // We check for membership_id in case we are being called too early in the process. This is
  59     // cludgey but is part of the deprecation process (ie. we are trying to do everything
  60     // from LineItem::create with a view to eventually removing this fn & the table.
  61     if (!civicrm_api3('Membership', 'getcount', ['id' => $params['membership_id']])) {
  62       return $dao;
  63     }
  64
  65     //Fixed for avoiding duplicate entry error when user goes
  66     //back and forward during payment mode is notify
  67     if (!$dao->find(TRUE)) {
  68       $dao->save();
  69     }
  70     CRM_Utils_Hook::post($hook, 'MembershipPayment', $dao->id, $dao);
  71     // CRM-14197 we are in the process on phasing out membershipPayment in favour of storing both contribution_id & entity_id (membership_id) on the line items
  72     // table. However, at this stage we have both - there is still quite a bit of refactoring to do to set the line_iten entity_id right the first time
  73     // however, we can assume at this stage that any contribution id will have only one line item with that membership type in the line item table
  74     // OR the caller will have taken responsibility for updating the line items themselves so we will update using SQL here
  75     if (!empty($params['isSkipLineItem'])) {
  76       // Caller has taken responsibility for updating the line items.
  77       return $dao;
  78     }
  79     if (!isset($params['membership_type_id'])) {
  80       $membership_type_id = civicrm_api3('membership', 'getvalue', [
  81         'id' => $dao->membership_id,
  82         'return' => 'membership_type_id',
  83       ]);
  84     }
  85     else {
  86       $membership_type_id = $params['membership_type_id'];
  87     }
  88     $sql = "UPDATE civicrm_line_item li
  89       LEFT JOIN civicrm_price_field_value pv ON pv.id = li.price_field_value_id
  90       SET entity_table = 'civicrm_membership', entity_id = %1
  91       WHERE pv.membership_type_id = %2
  92       AND contribution_id = %3";
  93     CRM_Core_DAO::executeQuery($sql, [
  94       1 => [$dao->membership_id, 'Integer'],
  95       2 => [$membership_type_id, 'Integer'],
  96       3 => [$dao->contribution_id, 'Integer'],
  97     ]);
  98     return $dao;
  99   }
 100
 101   /**
 102    * Delete membership Payments.
 103    *
 104    * @param int $id
 105    *
 106    * @return bool
 107    */
 108   public static function del($id) {
 109     $dao = new CRM_Member_DAO_MembershipPayment();
 110     $dao->id = $id;
 111     $result = FALSE;
 112     if ($dao->find(TRUE)) {
 113       $dao->delete();
 114       $result = TRUE;
 115     }
 116     return $result;
 117   }
 118
 119 }