api/v3/ActivityType.php

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