CRM/Contribute/Form/ContributionView.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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 (CRM_Utils_Array::value('contribution_page_id', $values)) {
  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 (CRM_Utils_Array::value('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 (CRM_Utils_Array::value('honor_contact_id', $values)) {
  74       $sql    = "SELECT display_name FROM civicrm_contact WHERE id = %1";
  75       $params = array(1 => array($values['honor_contact_id'], 'Integer'));
  76       $dao    = CRM_Core_DAO::executeQuery($sql, $params);
  77       if ($dao->fetch()) {
  78         $url = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid=$values[honor_contact_id]");
  79         $values['honor_display'] = "<A href = $url>" . $dao->display_name . "</A>";
  80       }
  81       $honor = CRM_Core_PseudoConstant::honor();
  82       $values['honor_type'] = CRM_Utils_Array::value(CRM_Utils_Array::value('honor_type_id', $values), $honor);
  83     }
  84
  85     if (CRM_Utils_Array::value('contribution_recur_id', $values)) {
  86       $sql    = "SELECT  installments, frequency_interval, frequency_unit FROM civicrm_contribution_recur WHERE id = %1";
  87       $params = array(1 => array($values['contribution_recur_id'], 'Integer'));
  88       $dao    = CRM_Core_DAO::executeQuery($sql, $params);
  89       if ($dao->fetch()) {
  90         $values['recur_installments'] = $dao->installments;
  91         $values['recur_frequency_unit'] = $dao->frequency_unit;
  92         $values['recur_frequency_interval'] = $dao->frequency_interval;
  93       }
  94     }
  95
  96     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Contribution', $this, $id, 0, CRM_Utils_Array::value('financial_type_id', $values));
  97     CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree);
  98
  99     $premiumId = NULL;
 100     if ($id) {
 101       $dao = new CRM_Contribute_DAO_ContributionProduct();
 102       $dao->contribution_id = $id;
 103       if ($dao->find(TRUE)) {
 104         $premiumId = $dao->id;
 105         $productID = $dao->product_id;
 106       }
 107     }
 108
 109     if ($premiumId) {
 110       $productDAO = new CRM_Contribute_DAO_Product();
 111       $productDAO->id = $productID;
 112       $productDAO->find(TRUE);
 113
 114       $this->assign('premium', $productDAO->name);
 115       $this->assign('option', $dao->product_option);
 116       $this->assign('fulfilled', $dao->fulfilled_date);
 117     }
 118
 119     // Get Note
 120     $noteValue = CRM_Core_BAO_Note::getNote(CRM_Utils_Array::value('id', $values), 'civicrm_contribution');
 121     $values['note'] = array_values($noteValue);
 122
 123     // show billing address location details, if exists
 124     if (CRM_Utils_Array::value('address_id', $values)) {
 125       $addressParams = array('id' => CRM_Utils_Array::value('address_id', $values));
 126       $addressDetails = CRM_Core_BAO_Address::getValues($addressParams, FALSE, 'id');
 127       $addressDetails = array_values($addressDetails);
 128       $values['billing_address'] = $addressDetails[0]['display'];
 129     }
 130
 131     //get soft credit record if exists.
 132     $softParams = array('contribution_id' => CRM_Utils_Array::value('contribution_id', $values));
 133     $softContribution = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($softParams);
 134     if (!empty($softContribution)) {
 135       foreach($softContribution as &$individualSoftContribution) {
 136         $individualSoftContribution['softCreditToName'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 137           $individualSoftContribution['soft_credit_to'], 'display_name'
 138         );
 139         //hack to avoid displayName conflict
 140         //for viewing softcredit record.
 141         $individualSoftContribution['displayName'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 142           $values['contact_id'], 'display_name'
 143         );
 144
 145       }
 146       $values['softContributions'] = $softContribution;
 147     }
 148
 149     $lineItems = array();
 150     if ($id) {
 151       $lineItem = CRM_Price_BAO_LineItem::getLineItems($id, 'contribution', 1);
 152       empty($lineItem) ? null :$lineItems[] =  $lineItem;
 153     }
 154     $this->assign('lineItem', empty($lineItems) ? FALSE : $lineItems);
 155     $values['totalAmount'] = $values['total_amount'];
 156
 157     //do check for campaigns
 158     if ($campaignId = CRM_Utils_Array::value('campaign_id', $values)) {
 159       $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns($campaignId);
 160       $values['campaign'] = $campaigns[$campaignId];
 161     }
 162
 163     // assign values to the template
 164     $this->assign($values);
 165
 166     $displayName = CRM_Contact_BAO_Contact::displayName($values['contact_id']);
 167     $this->assign('displayName', $displayName);
 168
 169     // Check if this is default domain contact CRM-10482
 170     if (CRM_Contact_BAO_Contact::checkDomainContact($values['contact_id'])) {
 171       $displayName .= ' (' . ts('default organization') . ')';
 172     }
 173
 174     // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
 175     CRM_Utils_System::setTitle(ts('View Contribution from') .  ' ' . $displayName);
 176
 177     // add viewed contribution to recent items list
 178     $url = CRM_Utils_System::url('civicrm/contact/view/contribution',
 179       "action=view&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 180     );
 181
 182     $title = $displayName . ' - (' . CRM_Utils_Money::format($values['total_amount']) . ' ' . ' - ' . $values['financial_type'] . ')';
 183
 184     $recentOther = array();
 185     if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::UPDATE)) {
 186       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 187         "action=update&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 188       );
 189     }
 190     if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
 191       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 192         "action=delete&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 193       );
 194     }
 195     CRM_Utils_Recent::add($title,
 196       $url,
 197       $values['id'],
 198       'Contribution',
 199       $values['contact_id'],
 200       NULL,
 201       $recentOther
 202     );
 203   }
 204
 205   /**
 206    * Function to build the form
 207    *
 208    * @return None
 209    * @access public
 210    */
 211   public function buildQuickForm() {
 212
 213     $this->addButtons(array(
 214         array(
 215           'type' => 'cancel',
 216           'name' => ts('Done'),
 217           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 218           'isDefault' => TRUE,
 219         ),
 220       )
 221     );
 222   }
 223 }
 224