api/v3/UFJoin.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 CiviCRM user framework join.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Takes an associative array and creates a uf join in the database.
  36  *
  37  * @param array $params
  38  *   Array per getfields metadata.
  39  *
  40  * @return array
  41  *   CRM_Core_DAO_UFJoin Array
  42  */
  43 function civicrm_api3_uf_join_create($params) {
  44
  45   $ufJoin = CRM_Core_BAO_UFJoin::create($params);
  46   _civicrm_api3_object_to_array($ufJoin, $ufJoinArray[]);
  47   return civicrm_api3_create_success($ufJoinArray, $params, 'UFJoin', 'create');
  48 }
  49
  50 /**
  51  * Adjust Metadata for Create action.
  52  *
  53  * @param array $params
  54  *   Array of parameters determined by getfields.
  55  *
  56  * @todo - suspect module, weight don't need to be required - need to test
  57  */
  58 function _civicrm_api3_uf_join_create_spec(&$params) {
  59   $params['module']['api.required'] = 1;
  60   $params['weight']['api.required'] = 1;
  61   $params['uf_group_id']['api.required'] = 1;
  62 }
  63
  64 /**
  65  * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record.
  66  *
  67  * @param array $params
  68  *   Array of name/value pairs.
  69  *
  70  * @return array
  71  *   API result array.
  72  */
  73 function civicrm_api3_uf_join_get($params) {
  74   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  75 }
  76
  77 /**
  78  * Delete a CiviCRM UF_Join.
  79  *
  80  * @param array $params
  81  *   Array of name/value pairs.
  82  *
  83  * @return array
  84  *   API result array.
  85  */
  86 function civicrm_api3_uf_join_delete($params) {
  87   return _civicrm_api3_basic_delete('CRM_Core_BAO_UFJoin', $params);
  88 }