3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * Definition of the ActivityType part of the CRM API.
30 * More detailed documentation can be found
31 * {@link http://objectledge.org/confluence/display/CRM/CRM+v1.0+Public+APIs
34 * @package CiviCRM_APIv3
35 * @subpackage API_Activity
37 * @copyright CiviCRM LLC (c) 2004-2014
38 * $Id: ActivityType.php 30171 2010-10-14 09:11:27Z mover $
43 * Function to retrieve activity types
47 * @return array $activityTypes activity types keyed by id
50 * @example ActivityTypeGet.php
51 * @deprecated - use getoptions
53 function civicrm_api3_activity_type_get($params) {
55 $activityTypes = CRM_Core_OptionGroup
::values('activity_type');
56 return civicrm_api3_create_success($activityTypes, $params, 'activity_type', 'get');
60 * Function to create activity type (
62 * @param array $params associated array of fields
63 * $params['option_value_id'] is required for updation of activity type
65 * @return array $activityType created / updated activity type
69 * @deprecated - we will introduce OptionValue Create - plse consider helping with this if not done
71 function civicrm_api3_activity_type_create($params) {
74 $groupParams = array('name' => 'activity_type');
76 if ($optionValueID = CRM_Utils_Array
::value('option_value_id', $params)) {
80 $activityObject = CRM_Core_OptionValue
::addOptionValue($params, $groupParams, $action, $optionValueID);
81 $activityType = array();
82 _civicrm_api3_object_to_array($activityObject, $activityType[$activityObject->id
]);
83 return civicrm_api3_create_success($activityType, $params, 'activity_type', 'create');
87 * Adjust Metadata for Create action
89 * The metadata is used for setting defaults, documentation & validation
90 * @param array $params array or parameters determined by getfields
92 function _civicrm_api3_activity_type_create_spec(&$params) {
93 $params['label']['api.required'] = 1;
94 $params['weight']['api.required'] = 1;
98 * Function to delete activity type
100 * @param array $params array including id of activity_type to delete
102 * @return array API result array
106 * @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done
108 function civicrm_api3_activity_type_delete($params) {
109 return civicrm_api3_create_success(CRM_Core_BAO_OptionValue
::del($params['id']), $params);