api/v3/GroupOrganization.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * File for the CiviCRM APIv3 group contact functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Group
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $
  36  */
  37
  38
  39 /**
  40  * Get group organization record/s.
  41  *
  42  * @param array $params
  43  *   Name value pair of contact information.
  44  *
  45  * @return array
  46  *   list of groups, given contact subscribed to
  47  */
  48 function civicrm_api3_group_organization_get($params) {
  49   return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
  50 }
  51
  52 /**
  53  * Create group organization record.
  54  *
  55  * @param array $params
  56  *   Array.
  57  *
  58  * @return array
  59  *
  60  */
  61 function civicrm_api3_group_organization_create($params) {
  62
  63   $groupOrgBAO = CRM_Contact_BAO_GroupOrganization::add($params);
  64
  65   if (is_null($groupOrgBAO)) {
  66     return civicrm_api3_create_error("group organization not created");
  67   }
  68
  69   _civicrm_api3_object_to_array($groupOrgBAO, $values);
  70   return civicrm_api3_create_success($values, $params, 'group_organization', 'get', $groupOrgBAO);
  71 }
  72
  73 /**
  74  * Adjust Metadata for Create action.
  75  *
  76  * The metadata is used for setting defaults, documentation & validation.
  77  *
  78  * @param array $params
  79  *   Array or parameters determined by getfields.
  80  */
  81 function _civicrm_api3_group_organization_create_spec(&$params) {
  82   $params['organization_id']['api.required'] = 1;
  83   $params['group_id']['api.required'] = 1;
  84 }
  85
  86 /**
  87  * Deletes an existing Group Organization.
  88  *
  89  * This API is used for deleting a Group Organization
  90  *
  91  * @param array $params
  92  *   With 'id' = ID of the Group Organization to be deleted.
  93  *
  94  * @return array
  95  *   API Result
  96  */
  97 function civicrm_api3_group_organization_delete($params) {
  98
  99   $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']);
 100   return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization');
 101 }