CRM/Contribute/Page/ContributionRecur.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * Main page for viewing Recurring Contributions.
  36  */
  37 class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page {
  38
  39   static $_links = NULL;
  40   public $_permission = NULL;
  41   public $_contactId = NULL;
  42
  43   /**
  44    * View details of a recurring contribution.
  45    */
  46   public function view() {
  47     $recur = new CRM_Contribute_DAO_ContributionRecur();
  48     $recur->id = $this->_id;
  49     if ($recur->find(TRUE)) {
  50       $values = array();
  51       CRM_Core_DAO::storeValues($recur, $values);
  52       // if there is a payment processor ID, get the name of the payment processor
  53       if (!empty($values['payment_processor_id'])) {
  54         $values['payment_processor'] = CRM_Core_DAO::getFieldValue(
  55           'CRM_Financial_DAO_PaymentProcessor',
  56           $values['payment_processor_id'],
  57           'name'
  58         );
  59       }
  60       $idFields = array('contribution_status_id', 'campaign_id');
  61       if (CRM_Contribute_BAO_ContributionRecur::supportsFinancialTypeChange($values['id'])) {
  62         $idFields[] = 'financial_type_id';
  63       }
  64       foreach ($idFields as $idField) {
  65         if (!empty($values[$idField])) {
  66           $values[substr($idField, 0, -3)] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionRecur', $idField, $values[$idField]);
  67         }
  68       }
  69
  70       // Add linked membership
  71       $membership = civicrm_api3('Membership', 'get', array(
  72         'contribution_recur_id' => $recur->id,
  73       ));
  74       if (!empty($membership['count'])) {
  75         $membershipDetails = reset($membership['values']);
  76         $values['membership_id'] = $membershipDetails['id'];
  77         $values['membership_name'] = $membershipDetails['membership_name'];
  78       }
  79
  80       $this->assign('recur', $values);
  81     }
  82   }
  83
  84   public function preProcess() {
  85     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
  86     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'view');
  87     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
  88     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  89     $this->assign('contactId', $this->_contactId);
  90
  91     // check logged in url permission
  92     CRM_Contact_Page_View::checkUserPermission($this);
  93
  94     $this->assign('action', $this->_action);
  95
  96     if ($this->_permission == CRM_Core_Permission::EDIT && !CRM_Core_Permission::check('edit contributions')) {
  97       // demote to view since user does not have edit contrib rights
  98       $this->_permission = CRM_Core_Permission::VIEW;
  99       $this->assign('permission', 'view');
 100     }
 101   }
 102
 103   /**
 104    * the main function that is called when the page loads,
 105    * it decides the which action has to be taken for the page.
 106    *
 107    * @return null
 108    */
 109   public function run() {
 110     $this->preProcess();
 111
 112     if ($this->_action & CRM_Core_Action::VIEW) {
 113       $this->view();
 114     }
 115
 116     return parent::run();
 117   }
 118
 119 }