Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-06-30-11-58-01
[civicrm-core.git] / api / v3 / LocationType.php
index 3a31c319d93063925ea870154237eee405c2f30e..c0097ebadd718956e26291ed9af9517c16c3e677 100644 (file)
@@ -1,11 +1,10 @@
 <?php
-// $Id$
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -33,7 +32,7 @@
  * @package CiviCRM_APIv3
  * @subpackage API_LocationType
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: LocationType.php 2012-11-02 Jon Goldberg $
  */
 
  *
  * @example LocationTypeCreate.php Standard Create Example
  *
+ * @param $params
+ *
  * @return array API result array
  * {@getfields email_create}
  * @access public
  */
-
 function civicrm_api3_location_type_create($params) {
   //set display_name equal to name if it's not defined
   if (!array_key_exists('display_name', $params) && array_key_exists('name', $params)) {
@@ -58,13 +58,12 @@ function civicrm_api3_location_type_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
-/*
+/**
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
  * @param array $params array or parameters determined by getfields
  */
-
 function _civicrm_api3_location_type_create_spec(&$params) {
   $params['is_active']['api.default'] = 1;
   $params['name']['api.required'] = 1;
@@ -81,7 +80,6 @@ function _civicrm_api3_location_type_create_spec(&$params) {
  * {@getfields LocationType_delete}
  * @access public
  */
-
 function civicrm_api3_location_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
@@ -100,9 +98,7 @@ function civicrm_api3_location_type_delete($params) {
  * {@getfields LocationType_get}
  * @access public
  */
-
 function civicrm_api3_location_type_get($params) {
-
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }