Merge remote-tracking branch 'upstream/4.4' into 4.4-4.5-2014-09-29-14-51-22
[civicrm-core.git] / CRM / Contact / BAO / SearchCustom.php
index 4af8f5b423226ef01c376f6bcecac6e05a47ec04..7d720f3a2a334ab3f3010173980d69c51f756e0f 100644 (file)
  */
 class CRM_Contact_BAO_SearchCustom {
 
+  /**
+   * @param $csID
+   * @param null $ssID
+   * @param null $gID
+   *
+   * @return array
+   * @throws Exception
+   */
   static function details($csID, $ssID = NULL, $gID = NULL) {
     $error = array(NULL, NULL, NULL);
 
@@ -91,6 +99,13 @@ class CRM_Contact_BAO_SearchCustom {
     return array($customSearchID, $customSearchClass, $formValues);
   }
 
+  /**
+   * @param $csID
+   * @param $ssID
+   *
+   * @return mixed
+   * @throws Exception
+   */
   static function customClass($csID, $ssID) {
     list($customSearchID, $customSearchClass, $formValues) = self::details($csID, $ssID);
 
@@ -104,11 +119,22 @@ class CRM_Contact_BAO_SearchCustom {
     return $customClass;
   }
 
+  /**
+   * @param $csID
+   * @param $ssID
+   *
+   * @return mixed
+   */
   static function contactIDSQL($csID, $ssID) {
     $customClass = self::customClass($csID, $ssID);
     return $customClass->contactIDs();
   }
 
+  /**
+   * @param $args
+   *
+   * @return array
+   */
   static function &buildFormValues($args) {
     $args = trim($args);
 
@@ -123,6 +149,12 @@ class CRM_Contact_BAO_SearchCustom {
     return $formValues;
   }
 
+  /**
+   * @param $csID
+   * @param $ssID
+   *
+   * @return array
+   */
   static function fromWhereEmail($csID, $ssID) {
     $customClass = self::customClass($csID, $ssID);