3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Core_Payment_Manual
extends CRM_Core_Payment
{
38 * This function checks to see if we have the right config values.
40 public function checkConfig() {}
43 * Get billing fields required for this processor.
45 * We apply the existing default of returning fields only for payment processor type 1. Processors can override to
48 * @param int $billingLocationID
52 public function getBillingAddressFields($billingLocationID = NULL) {
53 if (!$billingLocationID) {
54 // Note that although the billing id is passed around the forms the idea that it would be anything other than
55 // the result of the function below doesn't seem to have eventuated.
56 // So taking this as a param is possibly something to be removed in favour of the standard default.
57 $billingLocationID = CRM_Core_BAO_LocationType
::getBilling();
60 // Only handle pseudo-profile billing for now.
61 if ($this->billingProfile
== 'billing') {
62 // @todo - use profile api to retrieve this - either as pseudo-profile or (better) set up billing
63 // as a reserved profile in the DB and (even better) allow the profile to be selected
64 // on the form instead of just 'billing for pay=later bool'
66 'first_name' => 'billing_first_name',
67 'middle_name' => 'billing_middle_name',
68 'last_name' => 'billing_last_name',
69 'street_address' => "billing_street_address-{$billingLocationID}",
70 'city' => "billing_city-{$billingLocationID}",
71 'country' => "billing_country_id-{$billingLocationID}",
72 'state_province' => "billing_state_province_id-{$billingLocationID}",
73 'postal_code' => "billing_postal_code-{$billingLocationID}",
82 * Get array of fields that should be displayed on the payment form.
86 public function getPaymentFormFields() {
87 if (!$this->isBackOffice()) {
91 $paymentInstrument = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', $this->getPaymentInstrumentID());
92 if ($paymentInstrument === 'Credit Card') {
93 return array('credit_card_type', 'pan_truncation');
95 elseif ($paymentInstrument === 'Check') {
96 return array('check_number');
104 * The function ensures an exception is thrown & moves some of this logic out of the form layer and makes the forms
107 * @param array $params
109 * @param string $component
114 * @throws \Civi\Payment\Exception\PaymentProcessorException
116 public function doPayment(&$params, $component = 'contribute') {
117 $params['payment_status_id'] = $this->getResult();
122 * Get the result of the payment.
124 * Usually this will be pending but the calling layer has a chance to set the result.
126 * This would apply in particular when the form accepts status id.
128 * Note that currently this payment class is only being used to manage the 'billing block' aspect
129 * of pay later. However, a longer term idea is that by treating 'pay-later' as 'just another processor'
130 * will allow code simplification.
134 protected function getResult() {
135 if (!$this->result
) {
136 $this->setResult(CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'status_id', 'Pending'));
138 return $this->result
;
142 * Set the result to be returned.
144 * This would be set from outside the function where we want to pass on the status from the form.
148 public function setResult($result) {
149 $this->result
= $result;
153 * Set payment instrument id.
155 * @param int $paymentInstrumentID
157 public function setPaymentInstrumentID($paymentInstrumentID) {
158 $this->paymentInstrumentID
= $paymentInstrumentID;
162 * Get the name of the payment type.
166 public function getPaymentTypeName() {
171 * Get the name of the payment type.
175 public function getPaymentTypeLabel() {
176 return CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', $this->getPaymentInstrumentID());
180 * Declare that more than one payment can be processed at once.
184 protected function supportsMultipleConcurrentPayments() {
189 * Checks if backoffice recurring edit is allowed
193 public function supportsEditRecurringContribution() {
198 * Are back office payments supported.
202 protected function supportsBackOffice() {
207 * Submit a manual payment.
209 * @param array $params
210 * Assoc array of input parameters for this transaction.
214 public function doDirectPayment(&$params) {
215 $statuses = CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id');
216 if ($params['is_pay_later']) {
217 $result['payment_status_id'] = array_search('Pending', $statuses);
220 $result['payment_status_id'] = array_search('Completed', $statuses);
226 * Should a receipt be sent out for a pending payment.
228 * e.g for traditional pay later & ones with a delayed settlement a pending receipt makes sense.
230 public function isSendReceiptForPending() {