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