Merge pull request #4693 from jaapjansma/CRM-15702

[civicrm-core.git] / CRM / Core / BAO / CustomOption.php

diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php
index bf2cb527d980381536454b9b7b22104ec8a79a0e..07f3172a511c75568a85f30ff6c4c1d571f55b4f 100644 (file)
--- a/CRM/Core/BAO/CustomOption.php
+++ b/CRM/Core/BAO/CustomOption.php
@@ -40,16 +40,12 @@
 class CRM_Core_BAO_CustomOption {
 
   /**
-   * 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_CustomOption object
+   * @return CRM_Core_BAO_CustomOption object
    * @access public
    * @static
    */
@@ -66,10 +62,9 @@ class CRM_Core_BAO_CustomOption {
   /**
    * Returns all active options ordered by weight for a given field
    *
-   * @param $fieldID
+   * @param int $fieldID field whose options are needed
    * @param  boolean $inactiveNeeded do we need inactive options ?
    *
-   * @internal param int $fieldId field whose options are needed
    * @return array $customOption all active options for fieldId
    * @static
    */
@@ -166,7 +161,7 @@ WHERE  id = %1
   }
 
   /**
-   * Function to delete Option
+   * Delete Option
    *
    * param $optionId integer option id
    *
@@ -213,7 +208,7 @@ WHERE  id = %1";
   }
 
   /**
-   * @param $params
+   * @param array $params
    *
    * @throws Exception
    */
@@ -285,8 +280,8 @@ SET    {$dao->columnName} = REPLACE( {$dao->columnName}, %1, %2 )";
   }
 
   /**
-   * @param $customFieldID
-   * @param null $optionGroupID
+   * @param int $customFieldID
+   * @param int $optionGroupID
    *
    * @return array
    */