api/v3/CustomGroup.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  * File for the CiviCRM APIv3 custom group functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_CustomGroup
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: CustomGroup.php 30879 2010-11-22 15:45:55Z shot $
  36  */
  37
  38 /**
  39  * Most API functions take in associative arrays ( name => value pairs
  40  * as parameters. Some of the most commonly used parameters are
  41  * described below
  42  *
  43  * @param array $params
  44  *   An associative array used in construction.
  45  *   retrieval of the object
  46  * @todo missing get function
  47  *
  48  *
  49  */
  50
  51 /**
  52  * Use this API to create a new group.  The 'extends' value accepts an array or a comma separated string.
  53  * e.g array(
  54    'Individual','Contact') or 'Individual,Contact'
  55  * See the CRM Data Model for custom_group property definitions
  56  * $params['class_name'] is a required field, class being extended.
  57  *
  58  * @param array $params
  59  *   Array Associative array of property name/value pairs to insert in group.
  60  * {@getfields CustomGroup_create}
  61  *
  62  * @return array
  63  * @todo $params['extends'] is array format - is that std compatible
  64  */
  65 function civicrm_api3_custom_group_create($params) {
  66   if (isset($params['extends']) && is_string($params['extends'])) {
  67     $extends = explode(",", $params['extends']);
  68     unset($params['extends']);
  69     $params['extends'] = $extends;
  70   }
  71   if (!isset($params['extends'][0]) || !trim($params['extends'][0])) {
  72     return civicrm_api3_create_error("First item in params['extends'] must be a class name (e.g. 'Contact').");
  73   }
  74   if (isset($params['extends_entity_column_value']) && !is_array($params['extends_entity_column_value'])) {
  75     // BAO fails if this is a string, but API getFields says this must be a string, so we'll do a double backflip
  76     $params['extends_entity_column_value'] = CRM_Utils_Array::explodePadded($params['extends_entity_column_value']);
  77   }
  78
  79   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  80 }
  81
  82 /**
  83  * Adjust Metadata for Create action
  84  *
  85  * @param array $params
  86  *   Array or parameters determined by getfields.
  87  */
  88 function _civicrm_api3_custom_group_create_spec(&$params) {
  89   $params['extends']['api.required'] = 1;
  90   $params['title']['api.required'] = 1;
  91   $params['style']['api.default'] = 'Inline';
  92   $params['is_active']['api.default'] = 1;
  93 }
  94
  95 /**
  96  * Use this API to delete an existing group.
  97  *
  98  * @param array id of the group to be deleted
  99  *
 100  * @return Null
 101  *   if success
 102  */
 103 function civicrm_api3_custom_group_delete($params) {
 104
 105   $values = new CRM_Core_DAO_CustomGroup();
 106   $values->id = $params['id'];
 107   $values->find(TRUE);
 108
 109   $result = CRM_Core_BAO_CustomGroup::deleteGroup($values, TRUE);
 110   return $result ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting custom group');
 111 }
 112
 113 /**
 114  * Use this API to get existing custom fields.
 115  *
 116  * @param array $params
 117  *   Array to search on.
 118  *
 119  * @return array
 120  * * {@getfields CustomGroup_get}
 121  * @example CustomGroupGet.php
 122  **/
 123 function civicrm_api3_custom_group_get($params) {
 124   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 125 }
 126
 127 /**
 128  * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group
 129  * @param array $params
 130  * @return array
 131  */
 132 function civicrm_api3_custom_group_setvalue($params) {
 133   require_once 'api/v3/Generic/Setvalue.php';
 134   $result = civicrm_api3_generic_setValue(array("entity" => 'custom_group', 'params' => $params));
 135   if (empty($result['is_error'])) {
 136     CRM_Utils_System::flushCache();
 137   }
 138   return $result;
 139 }