CRM/Financial/BAO/FinancialItem.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem {
  37
  38   /**
  39    * class constructor
  40    */
  41   function __construct( ) {
  42     parent::__construct( );
  43   }
  44
  45   /**
  46    * Takes a bunch of params that are needed to match certain criteria and
  47    * retrieves the relevant objects. Typically the valid params are only
  48    * contact_id. We'll tweak this function to be more full featured over a period
  49    * of time. This is the inverse function of create. It also stores all the retrieved
  50    * values in the default array
  51    *
  52    * @param array $params   (reference ) an assoc array of name/value pairs
  53    * @param array $defaults (reference ) an assoc array to hold the flattened values
  54    *
  55    * @return object CRM_Contribute_BAO_FinancialItem object
  56    * @access public
  57    * @static
  58    */
  59   static function retrieve(&$params, &$defaults) {
  60     $financialItem = new CRM_Financial_DAO_FinancialItem();
  61     $financialItem->copyValues($params);
  62     if ($financialItem->find(TRUE)) {
  63       CRM_Core_DAO::storeValues($financialItem, $defaults);
  64       return $financialItem;
  65     }
  66     return NULL;
  67   }
  68
  69   /**
  70    * function to add the financial items and financial trxn
  71    *
  72    * @param object $lineItem     line item object
  73    * @param object $contribution contribution object
  74    *
  75    * @access public
  76    * @static
  77    * @return void
  78    */
  79   static function add($lineItem, $contribution) {
  80     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
  81     $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
  82     $itemStatus = NULL;
  83     if ($contribution->contribution_status_id == array_search('Completed', $contributionStatuses)
  84       || $contribution->contribution_status_id == array_search('Pending refund', $contributionStatuses)) {
  85       $itemStatus = array_search('Paid', $financialItemStatus);
  86     }
  87     elseif ($contribution->contribution_status_id == array_search('Pending', $contributionStatuses)
  88       || $contribution->contribution_status_id == array_search('In Progress', $contributionStatuses)) {
  89       $itemStatus = array_search('Unpaid', $financialItemStatus);
  90     }
  91     elseif ($contribution->contribution_status_id == array_search('Partially paid', $contributionStatuses)) {
  92       $itemStatus = array_search('Partially paid', $financialItemStatus);
  93     }
  94     $params = array(
  95       'transaction_date'  => CRM_Utils_Date::isoToMysql($contribution->receive_date),
  96       'contact_id'        => $contribution->contact_id,
  97       'amount'            => $lineItem->line_total,
  98       'currency'          => $contribution->currency,
  99       'entity_table'      => 'civicrm_line_item',
 100       'entity_id'         => $lineItem->id,
 101       'description'       => ( $lineItem->qty != 1 ? $lineItem->qty . ' of ' : ''). ' ' . $lineItem->label,
 102       'status_id'         => $itemStatus,
 103     );
 104
 105     if ($lineItem->financial_type_id) {
 106       $searchParams = array(
 107         'entity_table'         => 'civicrm_financial_type',
 108         'entity_id'            => $lineItem->financial_type_id,
 109         'account_relationship' => 1,
 110       );
 111
 112       $result = array();
 113       CRM_Financial_BAO_FinancialTypeAccount::retrieve( $searchParams, $result );
 114       $params['financial_account_id'] = CRM_Utils_Array::value( 'financial_account_id', $result );
 115     }
 116
 117     $trxn = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contribution->id, 'ASC', TRUE);
 118     $trxnId['id'] = $trxn['financialTrxnId'];
 119     return self::create($params, NULL, $trxnId);
 120   }
 121
 122   /**
 123    * function to create the financial Items and financial enity trxn
 124    *
 125    * @param array $params  associated array to create financial items
 126    * @param array $ids financial item ids
 127    * @param array $trxnIds financial item ids
 128    *
 129    * @access public
 130    * @static
 131    * @return object
 132    */
 133   static function create(&$params, $ids = NULL, $trxnIds = NULL) {
 134     $financialItem = new CRM_Financial_DAO_FinancialItem();
 135     $financialItem->copyValues($params);
 136     if (!empty($ids['id'])) {
 137       $financialItem->id = $ids['id'];
 138     }
 139
 140     $financialItem->save();
 141     if (!empty($trxnIds['id'])) {
 142       $entity_financial_trxn_params = array(
 143         'entity_table'      => "civicrm_financial_item",
 144         'entity_id'         => $financialItem->id,
 145         'financial_trxn_id' => $trxnIds['id'],
 146         'amount'            => $params['amount'],
 147       );
 148
 149       $entity_trxn = new CRM_Financial_DAO_EntityFinancialTrxn();
 150       $entity_trxn->copyValues($entity_financial_trxn_params);
 151       if (!empty($ids['entityFinancialTrxnId'])) {
 152         $entity_trxn->id = $ids['entityFinancialTrxnId'];
 153       }
 154       $entity_trxn->save();
 155     }
 156     return $financialItem;
 157   }
 158
 159   /**
 160    * takes an associative array and creates a entity financial transaction object
 161    *
 162    * @param array  $params (reference ) an assoc array of name/value pairs
 163    *
 164    * @return object CRM_Core_BAO_FinancialTrxn object
 165    * @access public
 166    * @static
 167    */
 168   static function createEntityTrxn($params) {
 169     $entity_trxn = new CRM_Financial_DAO_EntityFinancialTrxn();
 170     $entity_trxn->copyValues($params);
 171     $entity_trxn->save();
 172     return $entity_trxn;
 173   }
 174
 175   /**
 176    * retrive entity financial trxn details
 177    *
 178    * @param array $params (reference ) an assoc array of name/value pairs
 179    *
 180    * @param bool $maxId
 181    *
 182    * @internal param bool $maxID to retrive max id
 183    *
 184    * @return array
 185    * @access public
 186    * @static
 187    */
 188   static function retrieveEntityFinancialTrxn($params, $maxId = FALSE) {
 189     $financialItem = new CRM_Financial_DAO_EntityFinancialTrxn();
 190     $financialItem->copyValues($params);
 191     //retrieve last entry from civicrm_entity_financial_trxn
 192     if ($maxId) {
 193       $financialItem->orderBy('id DESC');
 194       $financialItem->limit(1);
 195     }
 196     $financialItem->find();
 197     while ($financialItem->fetch()) {
 198       $financialItems[$financialItem->id] = array(
 199         'id'                => $financialItem->id,
 200         'entity_table'      => $financialItem->entity_table,
 201         'entity_id'         => $financialItem->entity_id,
 202         'financial_trxn_id' => $financialItem->financial_trxn_id,
 203         'amount'            => $financialItem->amount,
 204       );
 205     }
 206     if (!empty($financialItems)) {
 207       return $financialItems;
 208     }
 209     else {
 210       return null;
 211     }
 212   }
 213
 214   /**
 215    * check if contact is present in financial_item table
 216    *
 217    * CRM-12929
 218    *
 219    * @param array $contactIds  an array contact id's
 220    *
 221    * @param array $error error to display
 222    *
 223    * @return array
 224    * @access public
 225    * @static
 226    */
 227   static function checkContactPresent($contactIds, &$error) {
 228     if (empty($contactIds)) {
 229       return FALSE;
 230     }
 231
 232     $allowPermDelete = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'allowPermDeleteFinancial');
 233
 234     if (!$allowPermDelete) {
 235       $sql = 'SELECT DISTINCT(cc.id), cc.display_name FROM civicrm_contact cc
 236 INNER JOIN civicrm_contribution con ON con.contact_id = cc.id
 237 WHERE cc.id IN (' . implode (',', $contactIds) . ') AND con.is_test = 0';
 238       $dao = CRM_Core_DAO::executeQuery($sql);
 239       if ($dao->N) {
 240         while ($dao->fetch()) {
 241           $url = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid=$dao->id");
 242           $not_deleted[$dao->id] = "<a href='$url'>$dao->display_name</a>";
 243         }
 244
 245         $errorStatus = '';
 246         if (is_array($error)) {
 247           $errorStatus = '<ul><li>' . implode('</li><li>', $not_deleted) . '</li></ul>';
 248         }
 249
 250         $error['_qf_default'] = $errorStatus .  ts('This contact(s) can not be permanently deleted because the contact record is linked to one or more live financial transactions. Deleting this contact would result in the loss of financial data.');
 251         return $error;
 252       }
 253     }
 254     return FALSE;
 255   }
 256 }