<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
*/
/**
- * Definition of the ActivityType part of the CRM API.
- * More detailed documentation can be found
- * {@link http://objectledge.org/confluence/display/CRM/CRM+v1.0+Public+APIs
- * here}
+ * @deprecated
*
* @package CiviCRM_APIv3
* @subpackage API_Activity
*/
/**
- * Function to retrieve activity types
- *
- * @param $params
+ * @deprecated api notice
+ * @return string
+ * to indicate this entire api entity is deprecated
+ */
+function _civicrm_api3_activity_type_deprecation() {
+ return 'The activity_type api is deprecated. Please use the option_value api instead.';
+}
+
+/**
+ * retrieve activity types
*
- * @return array $activityTypes activity types keyed by id
- * @access public
+ * @param array $params
*
- * @example ActivityTypeGet.php
+ * @return array
+ * activity types keyed by id
* @deprecated - use getoptions
*/
function civicrm_api3_activity_type_get($params) {
}
/**
- * Function to create activity type (
- *
- * @param array $params associated array of fields
- * $params['option_value_id'] is required for updation of activity type
+ * create activity type (
*
- * @return array $activityType created / updated activity type
+ * @param array $params
*
- * @access public
+ * @return array
+ * created / updated activity type
*
- * @deprecated - we will introduce OptionValue Create - plse consider helping with this if not done
+ * @deprecated - use option_value create
*/
function civicrm_api3_activity_type_create($params) {
* Adjust Metadata for Create action
*
* The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_activity_type_create_spec(&$params) {
$params['label']['api.required'] = 1;
}
/**
- * Function to delete activity type
+ * delete activity type
*
- * @param array $params array including id of activity_type to delete
+ * @param array $params
+ * Array including id of activity_type to delete.
- * @return array API result array
- *
- * @access public
+ * @return array
+ * API result array
*
* @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done
*/
function civicrm_api3_activity_type_delete($params) {
return civicrm_api3_create_success(CRM_Core_BAO_OptionValue::del($params['id']), $params);
}
-