| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 4.4 | |
| 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 | 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 | $params['created_id']['api.default'] = 'user_contact_id';//the current user |
| 49 | $params['created_date']['api.default'] = 'now'; |
| 50 | } |
| 51 | /** |
| 52 | * Use this API to create a new group. See the CRM Data Model for uf_group property definitions |
| 53 | * |
| 54 | * @param $params array Associative array of property name/value pairs to insert in group. |
| 55 | * |
| 56 | * @return array API result array |
| 57 | * {@getfields UFGroup_create} |
| 58 | * @example UFGroupCreate.php |
| 59 | * @access public |
| 60 | */ |
| 61 | function civicrm_api3_uf_group_create($params) { |
| 62 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Returns array of uf groups (profiles) matching a set of one or more group properties |
| 67 | * |
| 68 | * @param array $params (reference) Array of one or more valid |
| 69 | * property_name=>value pairs. If $params is set |
| 70 | * as null, all surveys will be returned |
| 71 | * |
| 72 | * @return array Array of matching profiles |
| 73 | * {@getfields UFGroup_get} |
| 74 | * @example UFGroupGet.php |
| 75 | * @access public |
| 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 $params |
| 86 | * |
| 87 | * @internal param int $groupId Valid uf_group id that to be deleted |
| 88 | * |
| 89 | * @return true on successful delete or return error |
| 90 | * @todo doesnt rtn success or error properly |
| 91 | * @access public |
| 92 | * {@getfields UFGroup_delete} |
| 93 | * @example UFGroupDelete.php |
| 94 | */ |
| 95 | function civicrm_api3_uf_group_delete($params) { |
| 96 | |
| 97 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 98 | } |
| 99 | |