api/v3/UFJoin.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * File for the CiviCRM APIv3 user framework join functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_UF
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: UFJoin.php 30171 2010-10-14 09:11:27Z mover $
  37  *
  38  */
  39
  40 /**
  41  * takes an associative array and creates a uf join in the database
  42  *
  43  * @param array $params
  44  *   Assoc array of name/value pairs.
  45  *
  46  * @return array
  47    *   CRM_Core_DAO_UFJoin Array
  48  * @access public
  49  * @example UFJoinCreate.php
  50  *  {@getfields UFJoin_create}
  51  *
  52  */
  53 function civicrm_api3_uf_join_create($params) {
  54
  55   $ufJoin = CRM_Core_BAO_UFJoin::create($params);
  56   _civicrm_api3_object_to_array($ufJoin, $ufJoinArray[]);
  57   return civicrm_api3_create_success($ufJoinArray, $params, 'uf_join', 'create');
  58 }
  59
  60 /**
  61  * Adjust Metadata for Create action
  62  *
  63  * @param array $params
  64  *   Array or parameters determined by getfields.
  65  * @todo - suspect module, weight don't need to be required - need to test
  66  */
  67 function _civicrm_api3_uf_join_create_spec(&$params) {
  68   $params['module']['api.required'] = 1;
  69   $params['weight']['api.required'] = 1;
  70   $params['uf_group_id']['api.required'] = 1;
  71 }
  72
  73 /**
  74  * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record
  75  *
  76  * @param array $params
  77  *   (reference) an assoc array of name/value pairs.
  78  *
  79  * @return array
  80    *   CiviCRM Result Array or null
  81  * @todo Delete function missing
  82  * @access public
  83  * {getfields UFJoin_get}
  84  */
  85 function civicrm_api3_uf_join_get($params) {
  86   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  87 }