api/v3/ActivityType.php

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