Merge pull request #11407 from cividesk/CRM-21553

[civicrm-core.git] / CRM / Member / Page / RecurringContributions.php

<?php\r
\r
/**\r
 * Shows list of recurring contributions related to membership.\r
 */\r
class CRM_Member_Page_RecurringContributions extends CRM_Core_Page {\r
\r
  /**\r
   * ID of the membership for which we need to see related recurring contributions.\r
   *\r
   * @var int\r
   */\r
  private $membershipID = NULL;\r
\r
  /**\r
   * ID of the contact owner of the membership.\r
   *\r
   * @var int\r
   */\r
  public $contactID = NULL;\r
\r
  /**\r
   * Builds list of recurring contributions associated to membership.\r
   *\r
   * @return null\r
   */\r
  public function run() {\r
    $this->membershipID = CRM_Utils_Request::retrieve('membershipID', 'Positive', $this);\r
    $this->contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);\r
\r
    $this->loadRecurringContributions();\r
\r
    return parent::run();\r
  }\r
\r
  /**\r
   * Loads recurring contributions and assigns them to the form, to be used on\r
   * the template.\r
   */\r
  private function loadRecurringContributions() {\r
    $recurringContributions = $this->getRecurContributions($this->membershipID);\r
\r
    if (!empty($recurringContributions)) {\r
      $this->assign('recurRows', $recurringContributions);\r
      $this->assign('recur', TRUE);\r
    }\r
  }\r
\r
  /**\r
   * Obtains list of recurring contributions associated to a membership.\r
   *\r
   * @param int $membershipID\r
   *\r
   * @return array\r
   */\r
  private function getRecurContributions($membershipID) {\r
    $result = civicrm_api3('MembershipPayment', 'get', array(\r
      'sequential' => 1,\r
      'contribution_id.contribution_recur_id.id' => ['IS NOT NULL' => TRUE],\r
      'options' => ['limit' => 0],\r
      'return' => array(\r
        'contribution_id.contribution_recur_id.id',\r
        'contribution_id.contribution_recur_id.contact_id',\r
        'contribution_id.contribution_recur_id.start_date',\r
        'contribution_id.contribution_recur_id.end_date',\r
        'contribution_id.contribution_recur_id.next_sched_contribution_date',\r
        'contribution_id.contribution_recur_id.amount',\r
        'contribution_id.contribution_recur_id.currency',\r
        'contribution_id.contribution_recur_id.frequency_unit',\r
        'contribution_id.contribution_recur_id.frequency_interval',\r
        'contribution_id.contribution_recur_id.installments',\r
        'contribution_id.contribution_recur_id.contribution_status_id',\r
        'contribution_id.contribution_recur_id.is_test',\r
        'contribution_id.contribution_recur_id.payment_processor_id',\r
      ),\r
      'membership_id' => $membershipID,\r
    ));\r
    $recurringContributions = array();\r
    $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus();\r
\r
    foreach ($result['values'] as $payment) {\r
      $recurringContributionID = $payment['contribution_id.contribution_recur_id.id'];\r
      $alreadyProcessed = isset($recurringContributions[$recurringContributionID]);\r
\r
      if ($alreadyProcessed) {\r
        continue;\r
      }\r
\r
      foreach ($payment as $field => $value) {\r
        $key = strtr($field, array('contribution_id.contribution_recur_id.' => ''));\r
        $recurringContributions[$recurringContributionID][$key] = $value;\r
      }\r
\r
      $contactID = $recurringContributions[$recurringContributionID]['contact_id'];\r
      $contributionStatusID = $recurringContributions[$recurringContributionID]['contribution_status_id'];\r
\r
      $recurringContributions[$recurringContributionID]['id'] = $recurringContributionID;\r
      $recurringContributions[$recurringContributionID]['contactId'] = $contactID;\r
      $recurringContributions[$recurringContributionID]['contribution_status'] = CRM_Utils_Array::value($contributionStatusID, $contributionStatuses);\r
\r
      $this->setActionsForRecurringContribution($recurringContributionID, $recurringContributions[$recurringContributionID]);\r
    }\r
    return $recurringContributions;\r
  }\r
\r
  /**\r
   * Calculates and assigns the actions available for given recurring\r
   * contribution.\r
   *\r
   * @param int $recurID\r
   * @param array $recurringContribution\r
   */\r
  private function setActionsForRecurringContribution($recurID, &$recurringContribution) {\r
    $action = array_sum(array_keys($this->recurLinks($recurID)));\r
    // no action allowed if it's not active\r
    $recurringContribution['is_active'] = ($recurringContribution['contribution_status_id'] != 3);\r
    if ($recurringContribution['is_active']) {\r
      $details = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($recurringContribution['id'], 'recur');\r
      $hideUpdate = $details->membership_id & $details->auto_renew;\r
      if ($hideUpdate || empty($details->processor_id)) {\r
        $action -= CRM_Core_Action::UPDATE;\r
      }\r
      $recurringContribution['action'] = CRM_Core_Action::formLink(\r
        $this->recurLinks($recurID),\r
        $action,\r
        array(\r
          'cid' => $this->contactID,\r
          'crid' => $recurID,\r
          'cxt' => 'contribution',\r
        ),\r
        ts('more'),\r
        FALSE,\r
        'contribution.selector.recurring',\r
        'Contribution',\r
        $recurID\r
      );\r
    }\r
  }\r
\r
  /**\r
   * This method returns the links that are given for recur search row.\r
   * currently the links added for each row are:\r
   * - View\r
   * - Edit\r
   * - Cancel\r
   *\r
   * @param bool $id\r
   *\r
   * @return array\r
   */\r
  private function recurLinks($id) {\r
    return CRM_Contribute_Page_Tab::recurLinks($id, 'contribution');\r
  }\r
\r
}\r