<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
| 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 location type functions
+ * This api exposes CiviCRM LocationType records.
*
* @package CiviCRM_APIv3
- * @subpackage API_LocationType
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: LocationType.php 2012-11-02 Jon Goldberg $
*/
/**
- * Add a Location Type
- *
- * Allowed @params array keys are:
- *
- * @example LocationTypeCreate.php Standard Create Example
+ * Add a LocationType.
*
* @param array $params
*
- * @return array API result array
- * {@getfields email_create}
- * @access public
+ * @return array
+ * API result array.
*/
function civicrm_api3_location_type_create($params) {
//set display_name equal to name if it's not defined
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_location_type_create_spec(&$params) {
$params['is_active']['api.default'] = 1;
}
/**
- * Deletes an existing Location Type
+ * Deletes an existing LocationType.
*
- * @param array $params
- *
- * @example LocationTypeDelete.php Standard Delete Example
+ * @param array $params
*
- * @return array API result array
- * {@getfields LocationType_delete}
- * @access public
+ * @return array
+ * API result array.
*/
function civicrm_api3_location_type_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Retrieve one or more Location Types
- *
- * @param array input parameters
- *
+ * Retrieve one or more LocationTypes.
*
- * @example LocationTypeGet.php Standard Get Example
- *
- * @param array $params an associative array of name/value pairs.
+ * @param array $params
+ * An associative array of name/value pairs.
*
- * @return array api result
- * {@getfields LocationType_get}
- * @access public
+ * @return array
+ * API result array.
*/
function civicrm_api3_location_type_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
-