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