INFRA-132 - Batch 14 (g)
[civicrm-core.git] / api / v3 / ActivityType.php
CommitLineData
6a488035 1<?php
6a488035
TO
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
6a488035 5 +--------------------------------------------------------------------+
731a0992 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26*/
27
28/**
a14e9d08 29 * @deprecated
6a488035
TO
30 *
31 * @package CiviCRM_APIv3
32 * @subpackage API_Activity
33 *
731a0992 34 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
35 * $Id: ActivityType.php 30171 2010-10-14 09:11:27Z mover $
36 *
37 */
38
a14e9d08
CW
39/**
40 * @deprecated api notice
a6c01b45 41 * @return string
72b3a70c 42 * to indicate this entire api entity is deprecated
a14e9d08
CW
43 */
44function _civicrm_api3_activity_type_deprecation() {
45 return 'The activity_type api is deprecated. Please use the option_value api instead.';
46}
47
6a488035 48/**
c490a46a 49 * retrieve activity types
6a488035 50 *
c490a46a 51 * @param array $params
77b97be7 52 *
a6c01b45 53 * @return array
72b3a70c 54 * activity types keyed by id
4e420887 55 * @deprecated - use getoptions
6a488035
TO
56 */
57function civicrm_api3_activity_type_get($params) {
58
6a488035
TO
59 $activityTypes = CRM_Core_OptionGroup::values('activity_type');
60 return civicrm_api3_create_success($activityTypes, $params, 'activity_type', 'get');
61}
62
63/**
c490a46a 64 * create activity type (
6a488035 65 *
cf470720 66 * @param array $params
6a488035 67 *
a6c01b45 68 * @return array
72b3a70c 69 * created / updated activity type
6a488035 70 *
a14e9d08 71 * @deprecated - use option_value create
6a488035
TO
72 */
73function civicrm_api3_activity_type_create($params) {
74
6a488035
TO
75 $action = 1;
76 $groupParams = array('name' => 'activity_type');
77
78 if ($optionValueID = CRM_Utils_Array::value('option_value_id', $params)) {
79 $action = 2;
80 }
81
6a488035
TO
82 $activityObject = CRM_Core_OptionValue::addOptionValue($params, $groupParams, $action, $optionValueID);
83 $activityType = array();
84 _civicrm_api3_object_to_array($activityObject, $activityType[$activityObject->id]);
85 return civicrm_api3_create_success($activityType, $params, 'activity_type', 'create');
86}
11e09c59
TO
87
88/**
6a488035 89 * Adjust Metadata for Create action
1c88e578 90 *
6a488035 91 * The metadata is used for setting defaults, documentation & validation
cf470720
TO
92 * @param array $params
93 * Array or parameters determined by getfields.
6a488035
TO
94 */
95function _civicrm_api3_activity_type_create_spec(&$params) {
96 $params['label']['api.required'] = 1;
1fdb479f 97 $params['label']['title'] = 'Label';
6a488035 98 $params['weight']['api.required'] = 1;
1fdb479f 99 $params['weight']['title'] = 'Weight';
6a488035
TO
100}
101
102/**
c490a46a 103 * delete activity type
6a488035 104 *
cf470720
TO
105 * @param array $params
106 * Array including id of activity_type to delete.
4e420887 107
a6c01b45 108 * @return array
72b3a70c 109 * API result array
6a488035 110 *
6a488035 111 * @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done
6a488035
TO
112 */
113function civicrm_api3_activity_type_delete($params) {
4e420887 114 return civicrm_api3_create_success(CRM_Core_BAO_OptionValue::del($params['id']), $params);
6a488035 115}