-<?php\r
-\r
-/**\r
- * Shows list of contributions done as payments within a recurring contribution.\r
- */\r
-class CRM_Contribute_Page_ContributionRecurPayments extends CRM_Core_Page {\r
-\r
- /**\r
- * Contribution ID\r
- *\r
- * @var int\r
- */\r
- private $id = NULL;\r
-\r
- /**\r
- * Contact ID\r
- *\r
- * @var int\r
- */\r
- private $contactId = NULL;\r
-\r
- /**\r
- * Builds list of contributions for a given recurring contribution.\r
- *\r
- * @return null\r
- */\r
- public function run() {\r
- $this->id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);\r
- $this->contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);\r
-\r
- $this->loadRelatedContributions();\r
-\r
- return parent::run();\r
- }\r
-\r
- /**\r
- * Loads contributions associated to the current recurring contribution being\r
- * viewed.\r
- */\r
- private function loadRelatedContributions() {\r
- $relatedContributions = array();\r
-\r
- $relatedContributionsResult = civicrm_api3('Contribution', 'get', array(\r
- 'sequential' => 1,\r
- 'contribution_recur_id' => $this->id,\r
- 'contact_id' => $this->contactId,\r
- 'options' => array('limit' => 0),\r
- ));\r
-\r
- foreach ($relatedContributionsResult['values'] as $contribution) {\r
- $this->insertAmountExpandingPaymentsControl($contribution);\r
- $this->fixDateFormats($contribution);\r
- $this->insertStatusLabels($contribution);\r
- $this->insertContributionActions($contribution);\r
-\r
- $relatedContributions[] = $contribution;\r
- }\r
-\r
- if (count($relatedContributions) > 0) {\r
- $this->assign('contributionsCount', count($relatedContributions));\r
- $this->assign('relatedContributions', json_encode($relatedContributions));\r
- }\r
- }\r
-\r
- /**\r
- * Inserts a string into the array with the html used to show the expanding\r
- * payments control, which loads when user clicks on the amount.\r
- *\r
- * @param array $contribution\r
- * Reference to the array holding the contribution's data and where the\r
- * control will be inserted into\r
- */\r
- private function insertAmountExpandingPaymentsControl(&$contribution) {\r
- $amount = CRM_Utils_Money::format($contribution['total_amount'], $contribution['currency']);\r
-\r
- $expandPaymentsUrl = CRM_Utils_System::url('civicrm/payment',\r
- array(\r
- 'view' => 'transaction',\r
- 'component' => 'contribution',\r
- 'action' => 'browse',\r
- 'cid' => $this->contactId,\r
- 'id' => $contribution['contribution_id'],\r
- 'selector' => 1,\r
- ),\r
- FALSE, NULL, TRUE\r
- );\r
-\r
- $contribution['amount_control'] = '\r
- <a class="nowrap bold crm-expand-row" title="view payments" href="' . $expandPaymentsUrl . '">\r
- ' . $amount . '\r
- </a>\r
- ';\r
- }\r
-\r
- /**\r
- * Fixes date fields present in the given contribution.\r
- *\r
- * @param array $contribution\r
- * Reference to the array holding the contribution's data\r
- */\r
- private function fixDateFormats(&$contribution) {\r
- $config = CRM_Core_Config::singleton();\r
-\r
- $contribution['formatted_receive_date'] = CRM_Utils_Date::customFormat($contribution['receive_date'], $config->dateformatDatetime);\r
- $contribution['formatted_thankyou_date'] = CRM_Utils_Date::customFormat($contribution['thankyou_date'], $config->dateformatDatetime);\r
- }\r
-\r
- /**\r
- * Inserts a contribution_status_label key into the array, with the value\r
- * showing the current status plus observations on the current status.\r
- *\r
- * @param array $contribution\r
- * Reference to the array holding the contribution's data and where the new\r
- * position will be inserted\r
- */\r
- private function insertStatusLabels(&$contribution) {\r
- $contribution['contribution_status_label'] = $contribution['contribution_status'];\r
-\r
- if ($contribution['is_pay_later'] && CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {\r
- $contribution['contribution_status_label'] .= ' (' . ts('Pay Later') . ')';\r
- }\r
- elseif (CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {\r
- $contribution['contribution_status_label'] .= ' (' . ts('Incomplete Transaction') . ')';\r
- }\r
- }\r
-\r
- /**\r
- * Inserts into the given array a string with the 'action' key, holding the\r
- * html to be used to show available actions for the contribution.\r
- *\r
- * @param $contribution\r
- * Reference to the array holding the contribution's data. It is also the\r
- * array where the new 'action' key will be inserted.\r
- */\r
- private function insertContributionActions(&$contribution) {\r
- $contribution['action'] = CRM_Core_Action::formLink(\r
- $this->buildContributionLinks($contribution),\r
- $this->getContributionPermissionsMask(),\r
- array(\r
- 'id' => $contribution['contribution_id'],\r
- 'cid' => $contribution['contact_id'],\r
- 'cxt' => 'contribution',\r
- ),\r
- ts('more'),\r
- FALSE,\r
- 'contribution.selector.row',\r
- 'Contribution',\r
- $contribution['contribution_id']\r
- );\r
- }\r
-\r
- /**\r
- * Builds list of links for authorized actions that can be done on given\r
- * contribution.\r
- *\r
- * @param array $contribution\r
- *\r
- * @return array\r
- */\r
- private function buildContributionLinks($contribution) {\r
- $links = CRM_Contribute_Selector_Search::links($contribution['contribution_id'],\r
- CRM_Utils_Request::retrieve('action', 'String'),\r
- NULL,\r
- NULL\r
- );\r
-\r
- $isPayLater = FALSE;\r
- if ($contribution['is_pay_later'] && CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {\r
- $isPayLater = TRUE;\r
-\r
- $links[CRM_Core_Action::ADD] = array(\r
- 'name' => ts('Pay with Credit Card'),\r
- 'url' => 'civicrm/contact/view/contribution',\r
- 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%&mode=live',\r
- 'title' => ts('Pay with Credit Card'),\r
- );\r
- }\r
-\r
- if (in_array($contribution['contribution_status'], array('Partially paid', 'Pending refund')) || $isPayLater) {\r
- $buttonName = ts('Record Payment');\r
-\r
- if ($contribution['contribution_status'] == 'Pending refund') {\r
- $buttonName = ts('Record Refund');\r
- }\r
- elseif (CRM_Core_Config::isEnabledBackOfficeCreditCardPayments()) {\r
- $links[CRM_Core_Action::BASIC] = array(\r
- 'name' => ts('Submit Credit Card payment'),\r
- 'url' => 'civicrm/payment/add',\r
- 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=contribution&mode=live',\r
- 'title' => ts('Submit Credit Card payment'),\r
- );\r
- }\r
- $links[CRM_Core_Action::ADD] = array(\r
- 'name' => $buttonName,\r
- 'url' => 'civicrm/payment',\r
- 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=contribution',\r
- 'title' => $buttonName,\r
- );\r
- }\r
-\r
- return $links;\r
- }\r
-\r
- /**\r
- * Builds a mask with allowed contribution related permissions.\r
- *\r
- * @return int\r
- */\r
- private function getContributionPermissionsMask() {\r
- $permissions = array(CRM_Core_Permission::VIEW);\r
- if (CRM_Core_Permission::check('edit contributions')) {\r
- $permissions[] = CRM_Core_Permission::EDIT;\r
- }\r
- if (CRM_Core_Permission::check('delete in CiviContribute')) {\r
- $permissions[] = CRM_Core_Permission::DELETE;\r
- }\r
-\r
- return CRM_Core_Action::mask($permissions);\r
- }\r
-\r
-}\r
+<?php
+
+/**
+ * Shows list of contributions done as payments within a recurring contribution.
+ */
+class CRM_Contribute_Page_ContributionRecurPayments extends CRM_Core_Page {
+
+ /**
+ * Contribution ID
+ *
+ * @var int
+ */
+ private $id = NULL;
+
+ /**
+ * Contact ID
+ *
+ * @var int
+ */
+ private $contactId = NULL;
+
+ /**
+ * Builds list of contributions for a given recurring contribution.
+ *
+ * @return null
+ */
+ public function run() {
+ $this->id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
+ $this->contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
+
+ $this->loadRelatedContributions();
+
+ return parent::run();
+ }
+
+ /**
+ * Loads contributions associated to the current recurring contribution being
+ * viewed.
+ */
+ private function loadRelatedContributions() {
+ $relatedContributions = array();
+
+ $relatedContributionsResult = civicrm_api3('Contribution', 'get', array(
+ 'sequential' => 1,
+ 'contribution_recur_id' => $this->id,
+ 'contact_id' => $this->contactId,
+ 'options' => array('limit' => 0),
+ ));
+
+ foreach ($relatedContributionsResult['values'] as $contribution) {
+ $this->insertAmountExpandingPaymentsControl($contribution);
+ $this->fixDateFormats($contribution);
+ $this->insertStatusLabels($contribution);
+ $this->insertContributionActions($contribution);
+
+ $relatedContributions[] = $contribution;
+ }
+
+ if (count($relatedContributions) > 0) {
+ $this->assign('contributionsCount', count($relatedContributions));
+ $this->assign('relatedContributions', json_encode($relatedContributions));
+ }
+ }
+
+ /**
+ * Inserts a string into the array with the html used to show the expanding
+ * payments control, which loads when user clicks on the amount.
+ *
+ * @param array $contribution
+ * Reference to the array holding the contribution's data and where the
+ * control will be inserted into
+ */
+ private function insertAmountExpandingPaymentsControl(&$contribution) {
+ $amount = CRM_Utils_Money::format($contribution['total_amount'], $contribution['currency']);
+
+ $expandPaymentsUrl = CRM_Utils_System::url('civicrm/payment',
+ array(
+ 'view' => 'transaction',
+ 'component' => 'contribution',
+ 'action' => 'browse',
+ 'cid' => $this->contactId,
+ 'id' => $contribution['contribution_id'],
+ 'selector' => 1,
+ ),
+ FALSE, NULL, TRUE
+ );
+
+ $contribution['amount_control'] = '
+ <a class="nowrap bold crm-expand-row" title="view payments" href="' . $expandPaymentsUrl . '">
+ ' . $amount . '
+ </a>
+ ';
+ }
+
+ /**
+ * Fixes date fields present in the given contribution.
+ *
+ * @param array $contribution
+ * Reference to the array holding the contribution's data
+ */
+ private function fixDateFormats(&$contribution) {
+ $config = CRM_Core_Config::singleton();
+
+ $contribution['formatted_receive_date'] = CRM_Utils_Date::customFormat($contribution['receive_date'], $config->dateformatDatetime);
+ $contribution['formatted_thankyou_date'] = CRM_Utils_Date::customFormat($contribution['thankyou_date'], $config->dateformatDatetime);
+ }
+
+ /**
+ * Inserts a contribution_status_label key into the array, with the value
+ * showing the current status plus observations on the current status.
+ *
+ * @param array $contribution
+ * Reference to the array holding the contribution's data and where the new
+ * position will be inserted
+ */
+ private function insertStatusLabels(&$contribution) {
+ $contribution['contribution_status_label'] = $contribution['contribution_status'];
+
+ if ($contribution['is_pay_later'] && CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {
+ $contribution['contribution_status_label'] .= ' (' . ts('Pay Later') . ')';
+ }
+ elseif (CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {
+ $contribution['contribution_status_label'] .= ' (' . ts('Incomplete Transaction') . ')';
+ }
+ }
+
+ /**
+ * Inserts into the given array a string with the 'action' key, holding the
+ * html to be used to show available actions for the contribution.
+ *
+ * @param $contribution
+ * Reference to the array holding the contribution's data. It is also the
+ * array where the new 'action' key will be inserted.
+ */
+ private function insertContributionActions(&$contribution) {
+ $contribution['action'] = CRM_Core_Action::formLink(
+ $this->buildContributionLinks($contribution),
+ $this->getContributionPermissionsMask(),
+ array(
+ 'id' => $contribution['contribution_id'],
+ 'cid' => $contribution['contact_id'],
+ 'cxt' => 'contribution',
+ ),
+ ts('more'),
+ FALSE,
+ 'contribution.selector.row',
+ 'Contribution',
+ $contribution['contribution_id']
+ );
+ }
+
+ /**
+ * Builds list of links for authorized actions that can be done on given
+ * contribution.
+ *
+ * @param array $contribution
+ *
+ * @return array
+ */
+ private function buildContributionLinks($contribution) {
+ $links = CRM_Contribute_Selector_Search::links($contribution['contribution_id'],
+ CRM_Utils_Request::retrieve('action', 'String'),
+ NULL,
+ NULL
+ );
+
+ $isPayLater = FALSE;
+ if ($contribution['is_pay_later'] && CRM_Utils_Array::value('contribution_status', $contribution) == 'Pending') {
+ $isPayLater = TRUE;
+
+ $links[CRM_Core_Action::ADD] = array(
+ 'name' => ts('Pay with Credit Card'),
+ 'url' => 'civicrm/contact/view/contribution',
+ 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%&mode=live',
+ 'title' => ts('Pay with Credit Card'),
+ );
+ }
+
+ if (in_array($contribution['contribution_status'], array('Partially paid', 'Pending refund')) || $isPayLater) {
+ $buttonName = ts('Record Payment');
+
+ if ($contribution['contribution_status'] == 'Pending refund') {
+ $buttonName = ts('Record Refund');
+ }
+ elseif (CRM_Core_Config::isEnabledBackOfficeCreditCardPayments()) {
+ $links[CRM_Core_Action::BASIC] = array(
+ 'name' => ts('Submit Credit Card payment'),
+ 'url' => 'civicrm/payment/add',
+ 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=contribution&mode=live',
+ 'title' => ts('Submit Credit Card payment'),
+ );
+ }
+ $links[CRM_Core_Action::ADD] = array(
+ 'name' => $buttonName,
+ 'url' => 'civicrm/payment',
+ 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=contribution',
+ 'title' => $buttonName,
+ );
+ }
+
+ return $links;
+ }
+
+ /**
+ * Builds a mask with allowed contribution related permissions.
+ *
+ * @return int
+ */
+ private function getContributionPermissionsMask() {
+ $permissions = array(CRM_Core_Permission::VIEW);
+ if (CRM_Core_Permission::check('edit contributions')) {
+ $permissions[] = CRM_Core_Permission::EDIT;
+ }
+ if (CRM_Core_Permission::check('delete in CiviContribute')) {
+ $permissions[] = CRM_Core_Permission::DELETE;
+ }
+
+ return CRM_Core_Action::mask($permissions);
+ }
+
+}
projects / civicrm-core.git / blobdiff