api/v3/SavedSearch.php

   1 <?php
   2
   3 /*
   4   +--------------------------------------------------------------------+
   5   | CiviCRM version 5                                                  |
   6   +--------------------------------------------------------------------+
   7   | Copyright Chirojeugd-Vlaanderen vzw 2015                           |
   8   +--------------------------------------------------------------------+
   9   | This file is a part of CiviCRM.                                    |
  10   |                                                                    |
  11   | CiviCRM is free software; you can copy, modify, and distribute it  |
  12   | under the terms of the GNU Affero General Public License           |
  13   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14   |                                                                    |
  15   | CiviCRM is distributed in the hope that it will be useful, but     |
  16   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18   | See the GNU Affero General Public License for more details.        |
  19   |                                                                    |
  20   | You should have received a copy of the GNU Affero General Public   |
  21   | License and the CiviCRM Licensing Exception along                  |
  22   | with this program; if not, contact CiviCRM LLC                     |
  23   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24   | GNU Affero General Public License or the licensing of CiviCRM,     |
  25   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26   +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * This api exposes CiviCRM saved searches.
  31  *
  32  * @package CiviCRM_APIv3
  33  */
  34
  35 /**
  36  * Create or update a saved search.
  37  *
  38  * @param array $params
  39  *   Associative array of property name-value pairs to insert in new saved search.
  40  * @example SavedSearch/Create.php Std create example.
  41  * @return array api result array
  42  *   {@getfields saved_search_create}
  43  * @access public
  44  */
  45 function civicrm_api3_saved_search_create($params) {
  46   civicrm_api3_verify_one_mandatory($params, NULL, ['form_values', 'where_clause']);
  47   // The create function of the dao expects a 'formValues' that is
  48   // not serialized. The get function returns form_values, that is
  49   // serialized.
  50   // So for the create API, I guess it should work for serialized and
  51   // unserialized form_values.
  52
  53   if (isset($params["form_values"])) {
  54     if (is_array($params["form_values"])) {
  55       $params["formValues"] = $params["form_values"];
  56     }
  57     else {
  58       // Assume that form_values is serialized.
  59       $params["formValues"] = unserialize($params["form_values"]);
  60     }
  61   }
  62
  63   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'SavedSearch');
  64   _civicrm_api3_saved_search_result_cleanup($result);
  65   return $result;
  66 }
  67
  68 /**
  69  * Delete an existing saved search.
  70  *
  71  * @param array $params
  72  *   Associative array of property name-value pairs. $params['id'] should be
  73  *   the ID of the saved search to be deleted.
  74  * @example SavedSearch/Delete.php Std delete example.
  75  * @return array api result array
  76  *   {@getfields saved_search_delete}
  77  * @access public
  78  */
  79 function civicrm_api3_saved_search_delete($params) {
  80   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  81 }
  82
  83 /**
  84  * Retrieve one or more saved search(es).
  85  *
  86  * @param array $params
  87  *   An associative array of name-value pairs.
  88  * @example SavedSearch/Get.php Std get example.
  89  * @return array api result array
  90  *   {@getfields saved_search_get}
  91  * @access public
  92  */
  93 function civicrm_api3_saved_search_get($params) {
  94   $result = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  95   _civicrm_api3_saved_search_result_cleanup($result);
  96   return $result;
  97 }
  98
  99 /**
 100  * This function unserializes the form_values in an SavedSearch API result.
 101  *
 102  * @param array $result API result to be cleaned up.
 103  */
 104 function _civicrm_api3_saved_search_result_cleanup(&$result) {
 105   if (isset($result['values']) && is_array($result['values'])) {
 106     // Only clean up the values if there are values. (A getCount operation
 107     // for example does not return values.)
 108     foreach ($result['values'] as $key => $value) {
 109       $result['values'][$key]['form_values'] = unserialize($value['form_values']);
 110     }
 111   }
 112 }