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     $this->assign('softContributions', $SCRecords['soft_credit']);
 122     unset($SCRecords['soft_credit']);
 123
 124     //assign pcp record if exists
 125     foreach ($SCRecords as $name => $value) {
 126       $this->assign($name, $value);
 127     }
 128
 129     $lineItems = array();
 130     if ($id) {
 131       $lineItem = CRM_Price_BAO_LineItem::getLineItems($id, 'contribution', 1);
 132       empty($lineItem) ? null :$lineItems[] =  $lineItem;
 133     }
 134     $this->assign('lineItem', empty($lineItems) ? FALSE : $lineItems);
 135     $values['totalAmount'] = $values['total_amount'];
 136
 137     //do check for campaigns
 138     if ($campaignId = CRM_Utils_Array::value('campaign_id', $values)) {
 139       $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns($campaignId);
 140       $values['campaign'] = $campaigns[$campaignId];
 141     }
 142
 143     // assign values to the template
 144     $this->assign($values);
 145
 146     $displayName = CRM_Contact_BAO_Contact::displayName($values['contact_id']);
 147     $this->assign('displayName', $displayName);
 148
 149     // Check if this is default domain contact CRM-10482
 150     if (CRM_Contact_BAO_Contact::checkDomainContact($values['contact_id'])) {
 151       $displayName .= ' (' . ts('default organization') . ')';
 152     }
 153
 154     // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
 155     CRM_Utils_System::setTitle(ts('View Contribution from') .  ' ' . $displayName);
 156
 157     // add viewed contribution to recent items list
 158     $url = CRM_Utils_System::url('civicrm/contact/view/contribution',
 159       "action=view&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 160     );
 161
 162     $title = $displayName . ' - (' . CRM_Utils_Money::format($values['total_amount']) . ' ' . ' - ' . $values['financial_type'] . ')';
 163
 164     $recentOther = array();
 165     if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::UPDATE)) {
 166       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 167         "action=update&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 168       );
 169     }
 170     if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
 171       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 172         "action=delete&reset=1&id={$values['id']}&cid={$values['contact_id']}&context=home"
 173       );
 174     }
 175     CRM_Utils_Recent::add($title,
 176       $url,
 177       $values['id'],
 178       'Contribution',
 179       $values['contact_id'],
 180       NULL,
 181       $recentOther
 182     );
 183   }
 184
 185   /**
 186    * Function to build the form
 187    *
 188    * @return void
 189    * @access public
 190    */
 191   public function buildQuickForm() {
 192
 193     $this->addButtons(array(
 194         array(
 195           'type' => 'cancel',
 196           'name' => ts('Done'),
 197           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 198           'isDefault' => TRUE,
 199         ),
 200       )
 201     );
 202   }
 203 }
 204