api/v3/CustomGroup.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * File for the CiviCRM APIv3 custom group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_CustomGroup
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: CustomGroup.php 30879 2010-11-22 15:45:55Z shot $
  37  */
  38
  39 /**
  40  * Most API functions take in associative arrays ( name => value pairs
  41  * as parameters. Some of the most commonly used parameters are
  42  * described below
  43  *
  44  * @param array $params
  45  *   An associative array used in construction.
  46  * retrieval of the object
  47  * @todo missing get function
  48  *
  49  *
  50  */
  51
  52 /**
  53  * Use this API to create a new group.  The 'extends' value accepts an array or a comma separated string.
  54  * e.g array(
  55    'Individual','Contact') or 'Individual,Contact'
  56  * See the CRM Data Model for custom_group property definitions
  57  * $params['class_name'] is a required field, class being extended.
  58  *
  59  * @param $params
  60  *   Array Associative array of property name/value pairs to insert in group.
  61  * {@getfields CustomGroup_create}
  62  *
  63  * @return Newly create custom_group object
  64  * @todo $params['extends'] is array format - is that std compatible
  65  * @access public
  66  */
  67 function civicrm_api3_custom_group_create($params) {
  68   if (isset($params['extends']) && is_string($params['extends'])) {
  69     $extends = explode(",", $params['extends']);
  70     unset($params['extends']);
  71     $params['extends'] = $extends;
  72   }
  73   if (!isset($params['extends'][0]) || !trim($params['extends'][0])) {
  74     return civicrm_api3_create_error("First item in params['extends'] must be a class name (e.g. 'Contact').");
  75   }
  76   if (isset($params['extends_entity_column_value']) && !is_array($params['extends_entity_column_value'])) {
  77     // BAO fails if this is a string, but API getFields says this must be a string, so we'll do a double backflip
  78     $params['extends_entity_column_value'] = CRM_Utils_Array::explodePadded($params['extends_entity_column_value']);
  79   }
  80
  81   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  82 }
  83
  84 /**
  85  * Adjust Metadata for Create action
  86  *
  87  * @param array $params
  88  *   Array or parameters determined by getfields.
  89  */
  90 function _civicrm_api3_custom_group_create_spec(&$params) {
  91   $params['extends']['api.required'] = 1;
  92   $params['title']['api.required'] = 1;
  93   $params['style']['api.default'] = 'Inline';
  94   $params['is_active']['api.default'] = 1;
  95 }
  96
  97 /**
  98  * Use this API to delete an existing group.
  99  *
 100  * @param array id of the group to be deleted
 101  *
 102  * @return Null
 103    *   if success
 104  * @access public
 105  * {@getfields CustomGroup_delete}
 106  * @example CustomGroupDelete.php
 107  **/
 108 function civicrm_api3_custom_group_delete($params) {
 109
 110   $values = new CRM_Core_DAO_CustomGroup();
 111   $values->id = $params['id'];
 112   $values->find(TRUE);
 113
 114   $result = CRM_Core_BAO_CustomGroup::deleteGroup($values, TRUE);
 115   return $result ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting custom group');
 116 }
 117
 118 /**
 119  * Use this API to get existing custom fields.
 120  *
 121  * @param array $params
 122  *   Array to search on.
 123  *
 124  * @return array
 125  * @access public
 126  * {@getfields CustomGroup_get}
 127  * @example CustomGroupGet.php
 128  **/
 129 function civicrm_api3_custom_group_get($params) {
 130   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 131 }
 132
 133 /**
 134  * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group
 135  */
 136 function civicrm_api3_custom_group_setvalue($params) {
 137   require_once 'api/v3/Generic/Setvalue.php';
 138   $result = civicrm_api3_generic_setValue(array("entity" => 'custom_group', 'params' => $params));
 139   if (empty($result['is_error'])) {
 140     CRM_Utils_System::flushCache();
 141   }
 142   return $result;
 143 }