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