CRM-15524 - Move static js resources to the html-header region so they don't reload...
[civicrm-core.git] / CRM / Core / OptionValue.php
index 5846d64d3523f13817018c25bb7203e782be46fd..1d7cf7fda12e098423ef17fa9e03d14a06d280c8 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -172,12 +172,13 @@ class CRM_Core_OptionValue {
   /**
    * Function to add/edit option-value of a particular group
    *
-   * @param  array     $params           Array containing exported values from the invoking form.
-   * @param  array     $groupParams      Array containing group fields whose option-values is to retrieved/saved.
-   * @param  string    $orderBy          for orderBy clause
-   * @param  integer   $optionValueID    has the id of the optionValue being edited, disabled ..etc
+   * @param  array $params Array containing exported values from the invoking form.
+   * @param  array $groupParams Array containing group fields whose option-values is to retrieved/saved.
+   * @param $action
+   * @param  integer $optionValueID has the id of the optionValue being edited, disabled ..etc
    *
-   * @return array of option-values
+   * @internal param string $orderBy for orderBy clause
+   * @return CRM_Core_DAO_OptionValue
    *
    * @access public
    * @static
@@ -239,10 +240,11 @@ class CRM_Core_OptionValue {
   /**
    * Check if there is a record with the same name in the db
    *
-   * @param string $value     the value of the field we are checking
-   * @param string $daoName   the dao object name
-   * @param string $daoID     the id of the object being updated. u can change your name
+   * @param string $value the value of the field we are checking
+   * @param string $daoName the dao object name
+   * @param string $daoID the id of the object being updated. u can change your name
    *                          as long as there is no conflict
+   * @param $optionGroupID
    * @param string $fieldName the name of the field in the DAO
    *
    * @return boolean     true if object exists
@@ -265,11 +267,14 @@ class CRM_Core_OptionValue {
   /**
    * Check if there is a record with the same name in the db
    *
-   * @param string $value     the value of the field we are checking
-   * @param string $daoName   the dao object name
-   * @param string $daoID     the id of the object being updated. u can change your name
+   * @param string $mode
+   * @param string $contactType
+   *
+   * @internal param string $value the value of the field we are checking
+   * @internal param string $daoName the dao object name
+   * @internal param string $daoID the id of the object being updated. u can change your name
    *                          as long as there is no conflict
-   * @param string $fieldName the name of the field in the DAO
+   * @internal param string $fieldName the name of the field in the DAO
    *
    * @return boolean     true if object exists
    * @access public
@@ -342,6 +347,8 @@ class CRM_Core_OptionValue {
   /**
    * build select query in case of option-values
    *
+   * @param $query
+   *
    * @return void
    * @access public
    */
@@ -369,7 +376,7 @@ class CRM_Core_OptionValue {
    *
    * @param  array     $groupParams   Array containing group fields
    *                                  whose option-values is to retrieved.
-   * @param  array     $values        (referance) to the array which
+   * @param  array     $values        (reference) to the array which
    *                                  will have the values for the group
    * @param  string    $orderBy       for orderBy clause
    *