api/v3/UFGroup.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28 */
  29
  30 /**
  31  * File for the CiviCRM APIv3 user framework group functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_UF
  35  *
  36  * @copyright CiviCRM LLC (c) 2004-2013
  37  * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
  38  *
  39  */
  40
  41 /**
  42  * Files required for this package
  43  */
  44
  45 function _civicrm_api3_uf_group_create_spec(&$params) {
  46   $session = CRM_Core_Session::singleton();
  47   $params['title']['api.required'] = 1;
  48   $params['is_active']['api.default'] = 1;
  49   $params['is_update_dupe']['api.default'] = 1;
  50   $params['created_id']['api.default'] = 'user_contact_id';//the current user
  51   $params['created_date']['api.default'] = 'now';
  52 }
  53 /**
  54  * Use this API to create a new group. See the CRM Data Model for uf_group property definitions
  55  *
  56  * @param $params  array   Associative array of property name/value pairs to insert in group.
  57  *
  58  * @return   Newly create $ufGroupArray array
  59  * {@getfields UFGroup_create}
  60  * @example UFGroupCreate.php
  61  * @access public
  62  */
  63 function civicrm_api3_uf_group_create($params) {
  64
  65   $ids = array();
  66   $ids['ufgroup'] = $params['id'];
  67
  68
  69   $ufGroup = CRM_Core_BAO_UFGroup::add($params, $ids);
  70   _civicrm_api3_object_to_array($ufGroup, $ufGroupArray[$ufGroup->id]);
  71
  72   return civicrm_api3_create_success($ufGroupArray, $params);
  73 }
  74
  75 /**
  76  * Returns array of uf groups (profiles)  matching a set of one or more group properties
  77  *
  78  * @param array $params  (reference) Array of one or more valid
  79  *                       property_name=>value pairs. If $params is set
  80  *                       as null, all surveys will be returned
  81  *
  82  * @return array   Array of matching profiles
  83  * {@getfields UFGroup_get}
  84  * @example UFGroupGet.php
  85  * @access public
  86  */
  87 function civicrm_api3_uf_group_get($params) {
  88
  89   return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params);
  90 }
  91
  92 /**
  93  * Delete uf group
  94  *
  95  * @param $groupId int  Valid uf_group id that to be deleted
  96  *
  97  * @return true on successful delete or return error
  98  * @todo doesnt rtn success or error properly
  99  * @access public
 100  * {@getfields UFGroup_delete}
 101  * @example UFGroupDelete.php
 102  */
 103 function civicrm_api3_uf_group_delete($params) {
 104
 105   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 106 }
 107