Merge pull request #4818 from pratikshad/CRM-15770

[civicrm-core.git] / CRM / Financial / BAO / PaymentProcessorType.php

diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php
index 23e27696b9c0b70eff082dceae8c2c46f0286830..cae630b5dbd0c0be86885f6afd789f1d32493816 100644 (file)
--- a/CRM/Financial/BAO/PaymentProcessorType.php
+++ b/CRM/Financial/BAO/PaymentProcessorType.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -35,32 +35,27 @@
 class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentProcessorType {
 
   /**
-   * static holder for the default payment processor
+   * Static holder for the default payment processor
    */
   static $_defaultPaymentProcessorType = NULL;
 
   /**
-   * class constructor
+   * Class constructor
    */
-  function __construct() {
+  public function __construct() {
     parent::__construct();
   }
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects. Typically the valid params are only
-   * contact_id. We'll tweak this function to be more full featured over a period
-   * of time. This is the inverse function of create. It also stores all the retrieved
-   * values in the default array
+   * Fetch object based on array of properties
    *
    * @param array $params   (reference ) an assoc array of name/value pairs
    * @param array $defaults (reference ) an assoc array to hold the flattened values
    *
-   * @return object CRM_Core_BAO_LocaationType object on success, null otherwise
-   * @access public
+   * @return CRM_Core_BAO_LocaationType object on success, null otherwise
    * @static
    */
-  static function retrieve(&$params, &$defaults) {
+  public static function retrieve(&$params, &$defaults) {
     $paymentProcessorType = new CRM_Financial_DAO_PaymentProcessorType();
     $paymentProcessorType->copyValues($params);
     if ($paymentProcessorType->find(TRUE)) {
@@ -71,31 +66,29 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr
   }
 
   /**
-   * update the is_active flag in the db
+   * Update the is_active flag in the db
    *
    * @param int      $id        id of the database record
    * @param boolean  $is_active value we want to set the is_active field
    *
    * @return Object             DAO object on sucess, null otherwise
    *
-   * @access public
    * @static
    */
-  static function setIsActive($id, $is_active) {
+  public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_PaymentProcessorType', $id, 'is_active', $is_active);
   }
 
   /**
-   * retrieve the default payment processor
+   * Retrieve the default payment processor
    *
    * @param NULL
    *
    * @return object           The default payment processor object on success,
    *                          null otherwise
    * @static
-   * @access public
    */
-  static function &getDefault() {
+  public static function &getDefault() {
     if (self::$_defaultPaymentProcessorType == NULL) {
       $params = array('is_default' => 1);
       $defaults = array();
@@ -105,18 +98,15 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr
   }
 
   /**
-   * Function to add the payment-processor type in the db
+   * Add the payment-processor type in the db
    *
    * @param array $params (reference ) an assoc array of name/value pairs
    *
    * @throws Exception
-   * @internal param array $ids the array that holds all the db ids
-   *
-   * @return object CRM_Financial_DAO_PaymentProcessorType
-   * @access public
+   * @return CRM_Financial_DAO_PaymentProcessorType
    * @static
    */
-  static function create(&$params) {
+  public static function create(&$params) {
     $paymentProcessorType = new CRM_Financial_DAO_PaymentProcessorType();
     $paymentProcessorType->copyValues($params);
 
@@ -176,15 +166,14 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr
   }
 
   /**
-   * Function to delete payment processor
+   * Delete payment processor
    *
    * @param  int $paymentProcessorTypeId ID of the processor to be deleted.
    *
    * @return bool
-   * @access public
    * @static
    */
-  static function del($paymentProcessorTypeId) {
+  public static function del($paymentProcessorTypeId) {
     $query = "
 SELECT pp.id processor_id
 FROM civicrm_payment_processor pp, civicrm_payment_processor_type ppt
@@ -206,6 +195,11 @@ WHERE pp.payment_processor_type_id = ppt.id AND ppt.id = %1";
     }
   }
 
+  /**
+   * @param $attr
+   *
+   * @return array
+   */
   static private function getAllPaymentProcessorTypes($attr) {
     $ppt = array();
     $dao = new CRM_Financial_DAO_PaymentProcessorType();
@@ -216,29 +210,4 @@ WHERE pp.payment_processor_type_id = ppt.id AND ppt.id = %1";
     return $ppt;
   }
 
-  /**
-   * Get options for a given field.
-   * @see CRM_Core_DAO::buildOptions
-   *
-   * @param String $fieldName
-   * @param String $context : @see CRM_Core_DAO::buildOptionsContext
-   * @param Array $props : whatever is known about this dao object
-   *
-   * @return Array|bool
-   */
-  public static function buildOptions($fieldName, $context = NULL, $props = array()) {
-    $params = array();
-    // Special logic for fields whose options depend on context or properties
-    switch ($fieldName) {
-      // These options are not in the db
-      case 'billing_mode':
-        return array(
-          CRM_Core_Payment::BILLING_MODE_FORM => 'form',
-          CRM_Core_Payment::BILLING_MODE_BUTTON => 'button',
-          CRM_Core_Payment::BILLING_MODE_NOTIFY => 'notify',
-        );
-    }
-    return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context);
-  }
 }
-