CRM/Contribute/Page/ContributionRecur.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * Main page for viewing Recurring Contributions.
  38  *
  39  */
  40 class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page {
  41
  42   static $_links = NULL;
  43   public $_permission = NULL;
  44   public $_contactId = NULL;
  45
  46   /**
  47    * View details of a recurring contribution
  48    *
  49    * @return void
  50    */ function view() {
  51     $recur = new CRM_Contribute_DAO_ContributionRecur();
  52     $recur->id = $this->_id;
  53     if ($recur->find(TRUE)) {
  54       $values = array();
  55       CRM_Core_DAO::storeValues($recur, $values);
  56       // if there is a payment processor ID, get the name of the payment processor
  57       if (!empty($values['payment_processor_id'])) {
  58         $values['payment_processor'] = CRM_Core_DAO::getFieldValue(
  59           'CRM_Financial_DAO_PaymentProcessor',
  60           $values['payment_processor_id'],
  61           'name'
  62         );
  63       }
  64       // get contribution status label
  65       if (!empty($values['contribution_status_id'])) {
  66         $values['contribution_status'] = CRM_Core_OptionGroup::getLabel('contribution_status', $values['contribution_status_id']);
  67       }
  68
  69       $this->assign('recur', $values);
  70     }
  71   }
  72
  73   public function preProcess() {
  74     $context          = CRM_Utils_Request::retrieve('context', 'String', $this);
  75     $this->_action    = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'view');
  76     $this->_id        = CRM_Utils_Request::retrieve('id', 'Positive', $this);
  77     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  78     $this->assign('contactId', $this->_contactId);
  79
  80     // check logged in url permission
  81     CRM_Contact_Page_View::checkUserPermission($this);
  82
  83     $this->assign('action', $this->_action);
  84
  85     if ($this->_permission == CRM_Core_Permission::EDIT && !CRM_Core_Permission::check('edit contributions')) {
  86       // demote to view since user does not have edit contrib rights
  87       $this->_permission = CRM_Core_Permission::VIEW;
  88       $this->assign('permission', 'view');
  89     }
  90   }
  91
  92   /**
  93    * This function is the main function that is called when the page loads,
  94    * it decides the which action has to be taken for the page.
  95    *
  96    * return null
  97    */
  98   public function run() {
  99     $this->preProcess();
 100
 101     if ($this->_action & CRM_Core_Action::VIEW) {
 102       $this->view();
 103     }
 104
 105     return parent::run();
 106   }
 107 }