api/v3/UFGroup.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  * This api exposes CiviCRM profile group.
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_UF
  33  *
  34  */
  35
  36 /**
  37  * Adjust metadata for create action.
  38  *
  39  * @param array $params
  40  */
  41 function _civicrm_api3_uf_group_create_spec(&$params) {
  42   $session = CRM_Core_Session::singleton();
  43   $params['title']['api.required'] = 1;
  44   $params['is_active']['api.default'] = 1;
  45   $params['is_update_dupe']['api.default'] = 1;
  46   // Default to the logged in user.
  47   $params['created_id']['api.default'] = 'user_contact_id';
  48   $params['created_date']['api.default'] = 'now';
  49 }
  50
  51 /**
  52  * Use this API to create a new group.
  53  *
  54  * See the CRM Data Model for uf_group property definitions
  55  *
  56  * @param array $params
  57  *   Array per getfields metadata.
  58  *
  59  * @return array
  60  *   API result array
  61  */
  62 function civicrm_api3_uf_group_create($params) {
  63   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  64 }
  65
  66 /**
  67  * Returns array of uf groups (profiles) matching a set of one or more group properties.
  68  *
  69  * @param array $params
  70  *   Array of one or more valid.
  71  *                       property_name=>value pairs. If $params is set
  72  *                       as null, all surveys will be returned
  73  *
  74  * @return array
  75  *   Array of matching profiles
  76  */
  77 function civicrm_api3_uf_group_get($params) {
  78
  79   return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params);
  80 }
  81
  82 /**
  83  * Delete uf group.
  84  *
  85  * @param array $params
  86  *
  87  * @return array
  88  */
  89 function civicrm_api3_uf_group_delete($params) {
  90   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  91 }