Merge pull request #9941 from eileenmcnaughton/comment

Add docblock comment to help with CRM-20058
civicrm · Mar 7, 2017 · 421606a · 421606a
2 parents 08a1ca1 + c1f9556
commit 421606a
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php
@@ -402,6 +402,21 @@ public static function getPaymentProcessors($capabilities = array(), $ids = FALS
 
   /**
    * Is there a processor on this site with the specified capability.
+   *
+   * The capabilities are defined on CRM_Core_Payment and can be extended by
+   * processors.
+   *
+   * examples are
+   *  - supportsBackOffice
+   *  - supportsLiveMode
+   *  - supportsFutureRecurDate
+   *  - supportsCancelRecurring
+   *  - supportsRecurContributionsForPledges
+   *
+   * They are passed as array('BackOffice');
+   *
+   * Details of specific functions are in the docblocks on the CRM_Core_Payment class.
+   *
    * @param array $capabilities
    *
    * @return bool