projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 6a488035 TO |
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 group contact functions | |
| 32 | * | |
| 33 | * @package CiviCRM_APIv3 | |
| 34 | * @subpackage API_Group | |
| 35 | * | |
| 36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
| 37 | * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $ | |
| 38 | * | |
| 39 | */ | |
| 40 | ||
| 41 | ||
| 42 | require_once 'CRM/Contact/BAO/GroupOrganization.php'; | |
| 43 | ||
| 44 | /** | |
| 45 | * This API will give list of the groups for particular contact | |
| 46 | * Particualr status can be sent in params array | |
| 47 | * If no status mentioned in params, by default 'added' will be used | |
| 48 | * to fetch the records | |
| 49 | * | |
| 50 | * @param array $params name value pair of contact information | |
| 51 | * {@getfields GroupOrganization_get} | |
| 52 | * @example GroupOrganizationGet.php | |
| 53 | * | |
| 54 | * @return array list of groups, given contact subsribed to | |
| 55 | */ | |
| 56 | function civicrm_api3_group_organization_get($params) { | |
| 57 | return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); | |
| 58 | } | |
| 59 | ||
| 60 | /** | |
| 61 | * @example GroupOrganizationCreate.php | |
| 62 | * {@getfields GroupOrganization_create} | |
| 63 | * | |
| 64 | * @param $params array | |
| 65 | * | |
| 66 | * @return array | |
| 67 | * | |
| 68 | */ | |
| 69 | function civicrm_api3_group_organization_create($params) { | |
| 70 | ||
| 71 | $groupOrgBAO = CRM_Contact_BAO_GroupOrganization::add($params); | |
| 72 | ||
| 73 | if (is_null($groupOrgBAO)) { | |
| 74 | return civicrm_api3_create_error("group organization not created"); | |
| 75 | } | |
| 76 | ||
| 77 | _civicrm_api3_object_to_array($groupOrgBAO, $values); | |
| 78 | return civicrm_api3_create_success($values, $params, 'group_organization', 'get', $groupOrgBAO); | |
| 79 | } | |
| 80 | ||
| 81 | /* | |
| 82 | * Adjust Metadata for Create action | |
| 83 | * | |
| 84 | * The metadata is used for setting defaults, documentation & validation | |
| 85 | * @param array $params array or parameters determined by getfields | |
| 86 | */ | |
| 87 | function _civicrm_api3_group_organization_create_spec(&$params) { | |
| 88 | $params['organization_id']['api.required'] = 1; | |
| 89 | $params['group_id']['api.required'] = 1; | |
| 90 | } | |
| 91 | ||
| 92 | /** | |
| 93 | * Deletes an existing Group Organization | |
| 94 | * | |
| 95 | * This API is used for deleting a Group Organization | |
| 96 | * | |
| 97 | * @param array $params with 'id' = ID of the Group Organization to be deleted | |
| 98 | * | |
| 99 | * @return array API Result | |
| 100 | * {@getfields GroupOrganization_delete} | |
| 101 | * @example GroupOrganizationDelete.php | |
| 102 | * @access public | |
| 103 | */ | |
| 104 | function civicrm_api3_group_organization_delete($params) { | |
| 105 | ||
| 106 | $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']); | |
| 107 | return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization'); | |
| 108 | } | |
| 109 |