class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch {
/**
- * class constructor
+ * Class constructor
*
* @return \CRM_Contact_BAO_SavedSearch CRM_Contact_BAO_SavedSearch
*/
}
/**
- * query the db for all saved searches.
+ * Query the db for all saved searches.
*
* @return array $aSavedSearch - contains the search name as value and and id as key
*
* @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_Contact_BAO_SavedSearch
+ * @return CRM_Contact_BAO_SavedSearch
* @access public
* @static
*/
}
/**
- * given an id, extract the formValues of the saved search
+ * Given an id, extract the formValues of the saved search
*
* @param int $id the id of the saved search
*
return $result;
}
+ /**
+ * @param int $id
+ *
+ * @return array
+ */
static function getSearchParams($id) {
$fv = self::getFormValues($id);
- //check if the saved seach has mapping id
+ //check if the saved search has mapping id
if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'mapping_id')) {
return CRM_Core_BAO_Mapping::formattedFields($fv);
}
}
/**
- * get the where clause for a saved search
+ * Get the where clause for a saved search
*
* @param int $id saved search id
* @param array $tables (reference ) add the tables that are needed for the select clause
return NULL;
}
+ /**
+ * @param int $id
+ *
+ * @return string
+ */
static function contactIDsSQL($id) {
$params = self::getSearchParams($id);
if ($params && !empty($params['customSearchID'])) {
}
}
+ /**
+ * @param int $id
+ *
+ * @return array
+ */
static function fromWhereEmail($id) {
$params = self::getSearchParams($id);
}
/**
- * given a saved search compute the clause and the tables
+ * Given a saved search compute the clause and the tables
* and store it for future use
*/
function buildClause() {
}
/**
- * given an id, get the name of the saved search
+ * Given an id, get the name of the saved search
*
* @param int $id the id of the saved search
*