api/v3/UFGroup.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.3                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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 user framework group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_UF
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
  37  *
  38  */
  39
  40 /**
  41  * Files required for this package
  42  */
  43
  44 function _civicrm_api3_uf_group_create_spec(&$params) {
  45   $session = CRM_Core_Session::singleton();
  46   $params['title']['api.required'] = 1;
  47   $params['is_active']['api.default'] = 1;
  48   $params['is_update_dupe']['api.default'] = 1;
  49   $params['created_id']['api.default'] = 'user_contact_id';//the current user
  50   $params['created_date']['api.default'] = 'now';
  51 }
  52 /**
  53  * Use this API to create a new group. See the CRM Data Model for uf_group property definitions
  54  *
  55  * @param $params  array   Associative array of property name/value pairs to insert in group.
  56  *
  57  * @return   Newly create $ufGroupArray array
  58  * {@getfields UFGroup_create}
  59  * @example UFGroupCreate.php
  60  * @access public
  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  (reference) Array of one or more valid
  70  *                       property_name=>value pairs. If $params is set
  71  *                       as null, all surveys will be returned
  72  *
  73  * @return array   Array of matching profiles
  74  * {@getfields UFGroup_get}
  75  * @example UFGroupGet.php
  76  * @access public
  77  */
  78 function civicrm_api3_uf_group_get($params) {
  79
  80   return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params);
  81 }
  82
  83 /**
  84  * Delete uf group
  85  *
  86  * @param $groupId int  Valid uf_group id that to be deleted
  87  *
  88  * @return true on successful delete or return error
  89  * @todo doesnt rtn success or error properly
  90  * @access public
  91  * {@getfields UFGroup_delete}
  92  * @example UFGroupDelete.php
  93  */
  94 function civicrm_api3_uf_group_delete($params) {
  95
  96   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  97 }
  98