CRM-16808 paypal express follow up fixes

[civicrm-core.git] / CRM / Core / OptionValue.php

diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php
index 09b71d7b0c8e0f80d49e9c9925b29ed43abe377d..90e3ec4e00699e20b15d18c047ab654da655322f 100644 (file)
--- a/CRM/Core/OptionValue.php
+++ b/CRM/Core/OptionValue.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,38 +23,35 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
 class CRM_Core_OptionValue {
 
   /**
-   * Static field for all the option value information that we can potentially export
+   * Static field for all the option value information that we can potentially export.
    *
    * @var array
-   * @static
    */
   static $_exportableFields = NULL;
 
   /**
-   * Static field for all the option value information that we can potentially export
+   * Static field for all the option value information that we can potentially export.
    *
    * @var array
-   * @static
    */
   static $_importableFields = NULL;
 
   /**
-   * Static field for all the option value information that we can potentially export
+   * Static field for all the option value information that we can potentially export.
    *
    * @var array
-   * @static
    */
   static $_fields = NULL;
 
@@ -63,15 +60,14 @@ class CRM_Core_OptionValue {
    *
    * @param array $groupParams
    *   Array containing group fields whose option-values is to retrieved.
-   * @param string $orderBy
-   *   For orderBy clause.
    * @param array $links
    *   Has links like edit, delete, disable ..etc.
+   * @param string $orderBy
+   *   For orderBy clause.
    *
    * @return array
-   *   of option-values
+   *   Array of option-values
    *
-   * @static
    */
   public static function getRows($groupParams, $links, $orderBy = 'weight') {
     $optionValue = array();
@@ -180,12 +176,11 @@ class CRM_Core_OptionValue {
    * @param array $groupParams
    *   Array containing group fields whose option-values is to retrieved/saved.
    * @param $action
-   * @param int $optionValueIDHas the id of the optionValue being edited, disabled ..etc.
+   * @param int $optionValueID Has the id of the optionValue being edited, disabled ..etc.
    *   Has the id of the optionValue being edited, disabled ..etc.
    *
    * @return CRM_Core_DAO_OptionValue
    *
-   * @static
    */
   public static function addOptionValue(&$params, &$groupParams, &$action, &$optionValueID) {
     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
@@ -219,7 +214,7 @@ class CRM_Core_OptionValue {
       $fieldValues = array('option_group_id' => $optionGroupID);
       // use the next available value
       /* CONVERT(value, DECIMAL) is used to convert varchar
-               field 'value' to decimal->integer                    */
+      field 'value' to decimal->integer                    */
 
       $params['value'] = (int) CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue',
         $fieldValues,
@@ -242,7 +237,7 @@ class CRM_Core_OptionValue {
   }
 
   /**
-   * Check if there is a record with the same name in the db
+   * Check if there is a record with the same name in the db.
    *
    * @param string $value
    *   The value of the field we are checking.
@@ -255,9 +250,8 @@ class CRM_Core_OptionValue {
    * @param string $fieldName
    *   The name of the field in the DAO.
    *
-   * @return boolean
+   * @return bool
    *   true if object exists
-   * @static
    */
   public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name') {
     $object = new $daoName();
@@ -273,14 +267,13 @@ class CRM_Core_OptionValue {
   }
 
   /**
-   * Check if there is a record with the same name in the db
+   * Check if there is a record with the same name in the db.
    *
    * @param string $mode
    * @param string $contactType
    *
-   * @return boolean
+   * @return bool
    *   true if object exists
-   * @static
    */
   public static function getFields($mode = '', $contactType = 'Individual') {
     $key = "$mode $contactType";
@@ -298,7 +291,7 @@ class CRM_Core_OptionValue {
         $nameTitle = array(
           'payment_instrument' => array(
             'name' => 'payment_instrument',
-            'title' => ts('Payment Instrument'),
+            'title' => ts('Payment Method'),
             'headerPattern' => '/^payment|(p(ayment\s)?instrument)$/i',
           ),
         );
@@ -310,7 +303,7 @@ class CRM_Core_OptionValue {
           'Individual',
           'Household',
           'Organization',
-          'All'
+          'All',
         ))) {
           $nameTitle = array(
             'addressee' => array(
@@ -388,13 +381,11 @@ class CRM_Core_OptionValue {
    * @param string $orderBy
    *   For orderBy clause.
    *
-   * @param bool $isActiveDo you want only active option values?.
-   *   Do you want only active option values?.
+   * @param bool $isActive Do you want only active option values?
    *
    * @return array
-   *   of option-values
+   *   Array of option-values
    *
-   * @static
    */
   public static function getValues($groupParams, &$values, $orderBy = 'weight', $isActive = FALSE) {
     if (empty($groupParams)) {
@@ -463,4 +454,5 @@ FROM
       );
     }
   }
+
 }