[civicrm-core.git] / api / v3 / UFJoin.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.6                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2014                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */

/**
 * File for the CiviCRM APIv3 user framework join functions
 *
 * @package CiviCRM_APIv3
 * @subpackage API_UF
 *
 * @copyright CiviCRM LLC (c) 2004-2014
 * @version $Id: UFJoin.php 30171 2010-10-14 09:11:27Z mover $
 *
 */

/**
 * takes an associative array and creates a uf join in the database
 *
 * @param array $params
 *   Assoc array of name/value pairs.
 *
 * @return array
 *   CRM_Core_DAO_UFJoin Array
 */
function civicrm_api3_uf_join_create($params) {

  $ufJoin = CRM_Core_BAO_UFJoin::create($params);
  _civicrm_api3_object_to_array($ufJoin, $ufJoinArray[]);
  return civicrm_api3_create_success($ufJoinArray, $params, 'uf_join', 'create');
}

/**
 * Adjust Metadata for Create action
 *
 * @param array $params
 *   Array or parameters determined by getfields.
 * @todo - suspect module, weight don't need to be required - need to test
 */
function _civicrm_api3_uf_join_create_spec(&$params) {
  $params['module']['api.required'] = 1;
  $params['weight']['api.required'] = 1;
  $params['uf_group_id']['api.required'] = 1;
}

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