From 415e7323b6b9582dfddb40f9d961c6498e6dd1fd Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 14 Sep 2020 12:57:17 +1200 Subject: [PATCH] Update code comments Making these a little less paypal specific --- CRM/Contribute/Form/ContributionBase.php | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/CRM/Contribute/Form/ContributionBase.php b/CRM/Contribute/Form/ContributionBase.php index 6822a355f6..7bb940637f 100644 --- a/CRM/Contribute/Form/ContributionBase.php +++ b/CRM/Contribute/Form/ContributionBase.php @@ -154,8 +154,18 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_action; /** - * Contribution mode e.g express for payment express, notify for off-site + notification back to CiviCRM + * Contribution mode. + * + * In general we are trying to deprecate this parameter but some templates and processors still + * require it to denote whether the processor redirects offsite (notify) or not. + * + * The intent is that this knowledge should not be required and all contributions should + * be created in a pending state and updated based on the payment result without needing to be + * aware of the processor workings. + * * @var string + * + * @deprecated */ public $_contributeMode; @@ -179,8 +189,10 @@ class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form { public $_emailExists = FALSE; /** - * Is this a backoffice form - * (this will affect whether paypal express code is displayed) + * Is this a backoffice form. + * + * Processors may display different options to backoffice users. + * * @var bool */ public $isBackOffice = FALSE; -- 2.25.1