api/v3/ActivityType.php

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