api/v3/GroupOrganization.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes the relationships between organizations and CiviCRM groups.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34
  35 /**
  36  * Get group organization record/s.
  37  *
  38  * @param array $params
  39  *   Name value pair of contact information.
  40  *
  41  * @return array
  42  *   list of groups, given contact subscribed to
  43  */
  44 function civicrm_api3_group_organization_get($params) {
  45   return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
  46 }
  47
  48 /**
  49  * Create group organization record.
  50  *
  51  * @param array $params
  52  *   Array.
  53  *
  54  * @return array
  55  */
  56 function civicrm_api3_group_organization_create($params) {
  57
  58   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'GroupOrganization');
  59 }
  60
  61 /**
  62  * Adjust Metadata for Create action.
  63  *
  64  * The metadata is used for setting defaults, documentation & validation.
  65  *
  66  * @param array $params
  67  *   Array of parameters determined by getfields.
  68  */
  69 function _civicrm_api3_group_organization_create_spec(&$params) {
  70   $params['organization_id']['api.required'] = 1;
  71   $params['group_id']['api.required'] = 1;
  72 }
  73
  74 /**
  75  * Deletes an existing Group Organization.
  76  *
  77  * This API is used for deleting a Group Organization
  78  *
  79  * @param array $params
  80  *   With 'id' = ID of the Group Organization to be deleted.
  81  *
  82  * @return array
  83  *   API Result
  84  */
  85 function civicrm_api3_group_organization_delete($params) {
  86
  87   $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']);
  88   return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization');
  89 }