| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 4.5 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 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 group functions |
| 31 | * |
| 32 | * @package CiviCRM_APIv3 |
| 33 | * @subpackage API_Group |
| 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
| 35 | * @version $Id: Group.php 30171 2010-10-14 09:11:27Z mover $ |
| 36 | */ |
| 37 | |
| 38 | /** |
| 39 | * create/update group |
| 40 | * |
| 41 | * This API is used to create new group or update any of the existing |
| 42 | * In case of updating existing group, id of that particular grop must |
| 43 | * be in $params array. Either id or name is required field in the |
| 44 | * $params array |
| 45 | * |
| 46 | * @param array $params (referance) Associative array of property |
| 47 | * name/value pairs to insert in new 'group' |
| 48 | * |
| 49 | * @return array returns id of the group created if success, |
| 50 | * error message otherwise |
| 51 | *@example GroupCreate.php |
| 52 | *{@getfields group_create} |
| 53 | * @access public |
| 54 | */ |
| 55 | function civicrm_api3_group_create($params) { |
| 56 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Group'); |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Adjust Metadata for Create action |
| 61 | * |
| 62 | * The metadata is used for setting defaults, documentation & validation |
| 63 | * @param array $params array or parameters determined by getfields |
| 64 | */ |
| 65 | function _civicrm_api3_group_create_spec(&$params) { |
| 66 | $params['is_active']['api.default'] = 1; |
| 67 | $params['title']['api.required'] = 1; |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Returns array of groups matching a set of one or more group properties |
| 72 | * |
| 73 | * @param array $params (referance) Array of one or more valid |
| 74 | * property_name=>value pairs. If $params is set |
| 75 | * as null, all groups will be returned |
| 76 | * |
| 77 | * @return array Array of matching groups |
| 78 | * @example GroupGet.php |
| 79 | * {@getfields group_get} |
| 80 | * @access public |
| 81 | */ |
| 82 | function civicrm_api3_group_get($params) { |
| 83 | $options = _civicrm_api3_get_options_from_params($params, TRUE, 'group', 'get'); |
| 84 | if(empty($options['return']) || !in_array('member_count', $options['return'])) { |
| 85 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Group'); |
| 86 | } |
| 87 | |
| 88 | $groups = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Group'); |
| 89 | foreach ($groups as $id => $group) { |
| 90 | $groups[$id]['member_count'] = CRM_Contact_BAO_Group::memberCount($id); |
| 91 | } |
| 92 | return civicrm_api3_create_success($groups, $params, 'group', 'get'); |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * delete an existing group |
| 97 | * |
| 98 | * This method is used to delete any existing group. id of the group |
| 99 | * to be deleted is required field in $params array |
| 100 | * |
| 101 | * @param array $params (referance) array containing id of the group |
| 102 | * to be deleted |
| 103 | * |
| 104 | * @return array (referance) returns flag true if successfull, error |
| 105 | * message otherwise |
| 106 | *@example GroupDelete.php |
| 107 | *{@getfields group_delete} |
| 108 | * |
| 109 | * @access public |
| 110 | */ |
| 111 | function civicrm_api3_group_delete($params) { |
| 112 | |
| 113 | CRM_Contact_BAO_Group::discard($params['id']); |
| 114 | return civicrm_api3_create_success(TRUE); |
| 115 | } |
| 116 | |