INFRA-132 - api/ - phpcbf
[civicrm-core.git] / api / v3 / UFJoin.php
index 4f3377d7f0d8e665e9095f2075e152937c91941d..43b5ea9ff9a61b0623769b740c1702cdb1e1fa60 100644 (file)
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -32,7 +32,7 @@
  * @package CiviCRM_APIv3
  * @subpackage API_UF
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: UFJoin.php 30171 2010-10-14 09:11:27Z mover $
  *
  */
@@ -40,7 +40,8 @@
 /**
  * takes an associative array and creates a uf join in the database
  *
- * @param array $params assoc array of name/value pairs
+ * @param array $params
+ *   Assoc array of name/value pairs.
  *
  * @return array CRM_Core_DAO_UFJoin Array
  * @access public
@@ -58,7 +59,8 @@ function civicrm_api3_uf_join_create($params) {
 /**
  * Adjust Metadata for Create action
  *
- * @param array $params array or parameters determined by getfields
+ * @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) {
@@ -70,7 +72,8 @@ function _civicrm_api3_uf_join_create_spec(&$params) {
 /**
  * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record
  *
- * @param array $params (reference) an assoc array of name/value pairs
+ * @param array $params
+ *   (reference) an assoc array of name/value pairs.
  *
  * @return array $result CiviCRM Result Array or null
  * @todo Delete function missing
@@ -80,4 +83,3 @@ function _civicrm_api3_uf_join_create_spec(&$params) {
 function civicrm_api3_uf_join_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-