+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| 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_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.
*
- * @return array $aSavedSearch - contains the search name as value and and id as key
- *
+ * @return array
+ * contains the search name as value and and id as key
*/
public function getAll() {
$savedSearch = new CRM_Contact_DAO_SavedSearch();
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
* (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contact_BAO_SavedSearch
- * @static
*/
public static function retrieve(&$params, &$defaults) {
$savedSearch = new CRM_Contact_DAO_SavedSearch();
* @param int $id
* The id of the saved search.
*
- * @return array the values of the posted saved search
- * @static
+ * @return array
+ * the values of the posted saved search
*/
public static function &getFormValues($id) {
$fv = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'form_values');
}
/**
- * Get the where clause for a saved search
+ * Get the where clause for a saved search.
*
* @param int $id
* Saved search id.
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
*
- * @return string the where clause for this saved search
- * @static
+ * @return string
+ * the where clause for this saved search
*/
public static function whereClause($id, &$tables, &$whereTables) {
$params = self::getSearchParams($id);
// this has not yet been implemented
}
else {
- return CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables);
- }
+ return CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables);
+ }
}
return NULL;
}
}
else {
$tables = $whereTables = array('civicrm_contact' => 1, 'civicrm_email' => 1);
- $where = CRM_Contact_BAO_SavedSearch::whereClause($id, $tables, $whereTables);
- $from = CRM_Contact_BAO_Query::fromClause($whereTables);
+ $where = CRM_Contact_BAO_SavedSearch::whereClause($id, $tables, $whereTables);
+ $from = CRM_Contact_BAO_Query::fromClause($whereTables);
return array($from, $where);
}
}
$this->where_tables = serialize($whereTables);
}
}
-
- return;
}
public function save() {
*
* @param string $value
*
- * @return string the name of the saved search
- * @static
+ * @return string
+ * the name of the saved search
*/
public static function getName($id, $value = 'name') {
$group = new CRM_Contact_DAO_Group();
$savedSearch->form_values = serialize($params['formValues']);
}
else {
- $savedSearch->form_values = 'null';
+ $savedSearch->form_values = NULL;
}
$savedSearch->is_active = CRM_Utils_Array::value('is_active', $params, 1);
return $savedSearch;
}
+
}