CRM/Contribute/Form/ContributionView.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 /**
  37  * This class generates form components for Payment-Instrument
  38  *
  39  */
  40 class CRM_Contribute_Form_ContributionView extends CRM_Core_Form {
  41
  42   /**
  43    * Set variables up before form is built
  44    *
  45    * @return void
  46    * @access public
  47    */
  48   public function preProcess() {
  49     $id      = $this->get('id');
  50     $values  = $ids = array();
  51     $params  = array('id' => $id);
  52     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
  53     $this->assign('context', $context);
  54
  55     CRM_Contribute_BAO_Contribution::getValues($params, $values, $ids);
  56     CRM_Contribute_BAO_Contribution::resolveDefaults($values);
  57     $cancelledStatus = TRUE;
  58     $status = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
  59     if (CRM_Utils_Array::value('contribution_status_id', $values) == array_search('Cancelled', $status)) {
  60       $cancelledStatus = FALSE;
  61     }
  62     $this->assign('cancelledStatus', $cancelledStatus);
  63
  64     if (!empty($values['contribution_page_id'])) {
  65       $contribPages = CRM_Contribute_PseudoConstant::contributionPage(NULL, TRUE);
  66       $values['contribution_page_title'] = CRM_Utils_Array::value(CRM_Utils_Array::value('contribution_page_id', $values), $contribPages);
  67     }
  68
  69     // get recieved into i.e to_financial_account_id from last trxn
  70     $financialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($values['contribution_id'], 'DESC');
  71     $values['to_financial_account'] = '';
  72     if (!empty($financialTrxnId['financialTrxnId'])) {
  73       $values['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $financialTrxnId['financialTrxnId'], 'to_financial_account_id');
  74       if ($values['to_financial_account_id']) {
  75         $values['to_financial_account'] = CRM_Contribute_PseudoConstant::financialAccount($values['to_financial_account_id']);
  76       }
  77     }
  78
  79     if (!empty($values['contribution_recur_id'])) {
  80       $sql    = "SELECT  installments, frequency_interval, frequency_unit FROM civicrm_contribution_recur WHERE id = %1";
  81       $params = array(1 => array($values['contribution_recur_id'], 'Integer'));
  82       $dao    = CRM_Core_DAO::executeQuery($sql, $params);
  83       if ($dao->fetch()) {
  84         $values['recur_installments'] = $dao->installments;
  85         $values['recur_frequency_unit'] = $dao->frequency_unit;
  86         $values['recur_frequency_interval'] = $dao->frequency_interval;
  87       }
  88     }
  89
  90     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Contribution', $this, $id, 0, CRM_Utils_Array::value('financial_type_id', $values));
  91     CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree);
  92
  93     $premiumId = NULL;
  94     if ($id) {
  95       $dao = new CRM_Contribute_DAO_ContributionProduct();
  96       $dao->contribution_id = $id;
  97       if ($dao->find(TRUE)) {
  98         $premiumId = $dao->id;
  99         $productID = $dao->product_id;
 100       }
 101     }
 102
 103     if ($premiumId) {
 104       $productDAO = new CRM_Contribute_DAO_Product();
 105       $productDAO->id = $productID;
 106       $productDAO->find(TRUE);
 107
 108       $this->assign('premium', $productDAO->name);
 109       $this->assign('option', $dao->product_option);
 110       $this->assign('fulfilled', $dao->fulfilled_date);
 111     }
 112
 113     // Get Note
 114     $noteValue = CRM_Core_BAO_Note::getNote(CRM_Utils_Array::value('id', $values), 'civicrm_contribution');
 115     $values['note'] = array_values($noteValue);
 116
 117     // show billing address location details, if exists
 118     if (!empty($values['address_id'])) {
 119       $addressParams = array('id' => CRM_Utils_Array::value('address_id', $values));
 120       $addressDetails = CRM_Core_BAO_Address::getValues($addressParams, FALSE, 'id');
 121       $addressDetails = array_values($addressDetails);
 122       $values['billing_address'] = $addressDetails[0]['display'];
 123     }
 124
 125     //assign soft credit record if exists.
 126     $SCRecords = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($values['contribution_id'], TRUE);
 127     if (!empty($SCRecords['soft_credit'])) {
 128       $this->assign('softContributions', $SCRecords['soft_credit']);
 129       unset($SCRecords['soft_credit']);
 130     }
 131
 132     //assign pcp record if exists
 133     foreach ($SCRecords as $name => $value) {
 134       $this->assign($name, $value);
 135     }
 136
 137     $lineItems = array();
 138     if ($id) {
 139       $lineItem = CRM_Price_BAO_LineItem::getLineItems($id, 'contribution', 1, TRUE, TRUE);
 140       if (!empty($lineItem)) {
 141         $lineItems[] = $lineItem;
 142       }
 143
 144     }
 145     $this->assign('lineItem', empty($lineItems) ? FALSE : $lineItems);
 146     $values['totalAmount'] = $values['total_amount'];
 147
 148     //do check for campaigns
 149     if ($campaignId = CRM_Utils_Array::value('campaign_id', $values)) {
 150       $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns($campaignId);
 151       $values['campaign'] = $campaigns[$campaignId];
 152     }
 153
 154     // assign values to the template
 155     $this->assign($values);
 156     $invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME,'contribution_invoice_settings');
 157     $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
 158     $this->assign('invoicing', $invoicing);
 159     if ($invoicing && isset($values['tax_amount'])) {
 160       $this->assign('totalTaxAmount', $values['tax_amount']);
 161     }
 162
 163     $displayName = CRM_Contact_BAO_Contact::displayName($values['contact_id']);
 164     $this->assign('displayName', $displayName);
 165
 166     // Check if this is default domain contact CRM-10482
 167     if (CRM_Contact_BAO_Contact::checkDomainContact($values['contact_id'])) {
 168       $displayName .= ' (' . ts('default organization') . ')';
 169     }
 170
 171     // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
 172     CRM_Utils_System::setTitle(ts('View Contribution from') .  ' ' . $displayName);
 173
 174     // add viewed contribution to recent items list
 175     $url = CRM_Utils_System::url('civicrm/contact/view/contribution',
 176       "action=view&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 177     );
 178
 179     $title = $displayName . ' - (' . CRM_Utils_Money::format($values['total_amount']) . ' ' . ' - ' . $values['financial_type'] . ')';
 180
 181     $recentOther = array();
 182     if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::UPDATE)) {
 183       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 184         "action=update&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 185       );
 186     }
 187     if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
 188       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 189         "action=delete&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 190       );
 191     }
 192     CRM_Utils_Recent::add($title,
 193       $url,
 194       $values['id'],
 195       'Contribution',
 196       $values['contact_id'],
 197       NULL,
 198       $recentOther
 199     );
 200   }
 201
 202   /**
 203    * Build the form object
 204    *
 205    * @return void
 206    * @access public
 207    */
 208   public function buildQuickForm() {
 209
 210     $this->addButtons(array(
 211         array(
 212           'type' => 'cancel',
 213           'name' => ts('Done'),
 214           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 215           'isDefault' => TRUE,
 216         ),
 217       )
 218     );
 219   }
 220 }