Merge pull request #5983 from relldoesphp/CRM-16544

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

diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php
index e8627b24184a90b50e9ef4109d1023bab2c76a17..82c40570e70b63cc3baeb026662669062474415e 100644 (file)
--- a/CRM/Core/OptionValue.php
+++ b/CRM/Core/OptionValue.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,33 +23,33 @@
  | 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 $_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 $_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
    */
@@ -60,10 +60,10 @@ 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
    *   Array of option-values
@@ -176,7 +176,7 @@ 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
@@ -214,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,
@@ -237,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.
@@ -250,7 +250,7 @@ class CRM_Core_OptionValue {
    * @param string $fieldName
    *   The name of the field in the DAO.
    *
-   * @return boolean
+   * @return bool
    *   true if object exists
    */
   public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name') {
@@ -267,12 +267,12 @@ 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
    */
   public static function getFields($mode = '', $contactType = 'Individual') {
@@ -303,7 +303,7 @@ class CRM_Core_OptionValue {
           'Individual',
           'Household',
           'Organization',
-          'All'
+          'All',
         ))) {
           $nameTitle = array(
             'addressee' => array(
@@ -381,8 +381,7 @@ 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
    *   Array of option-values
@@ -455,4 +454,5 @@ FROM
       );
     }
   }
+
 }