api/v3/CaseType.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  * File for the CiviCRM APIv3 Case functions
  30  * Developed by woolman.org
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Case
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  *
  36  */
  37
  38 /**
  39  * Function to create or update case type
  40  *
  41  * @param  array $params   input parameters
  42  *
  43  * Allowed @params array keys are:
  44  * {@getfields case_type_create}
  45  *
  46  * @throws API_Exception
  47  * @return array API result array
  48  *
  49  * @static void
  50  * @access public
  51  */
  52 function civicrm_api3_case_type_create($params) {
  53   civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__));
  54   unset($params['is_forkable']); // computed property
  55   unset($params['is_forked']); // computed property
  56
  57   if (!array_key_exists('is_active', $params) && empty($params['id'])) {
  58     $params['is_active'] = TRUE;
  59   }
  60   if (!empty($params['id']) // this is an existing case-type
  61     && !CRM_Case_BAO_CaseType::isForked($params['id']) // which is not yet forked
  62     && !CRM_Case_BAO_CaseType::isForkable($params['id']) // for which new forks are prohibited
  63   ) {
  64     unset($params['definition']);
  65   }
  66   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'CaseType');
  67   return _civicrm_api3_case_type_get_formatResult($result);
  68 }
  69
  70 /**
  71  * Function to retrieve case types
  72  *
  73  * @param $params
  74  *
  75  * @return array $caseTypes case types keyed by id
  76  * @access public
  77  */
  78 function civicrm_api3_case_type_get($params) {
  79   civicrm_api3_verify_mandatory($params);
  80   $caseTypes = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  81
  82   // format case type, to fetch xml definition
  83   return _civicrm_api3_case_type_get_formatResult($caseTypes);
  84 }
  85
  86 /**
  87  * Function to format definition
  88  *
  89  * @param $caseTypes
  90  * @return mixed
  91  */
  92 function _civicrm_api3_case_type_get_formatResult(&$result) {
  93   foreach ($result['values'] as $key => $caseType) {
  94     $caseTypeName = (isset($caseType['name'])) ? $caseType['name'] : CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseType['id'], 'name', 'id', TRUE);
  95     $xml = CRM_Case_XMLRepository::singleton()->retrieve($caseTypeName);
  96     if ($xml) {
  97       $result['values'][$key]['definition'] = CRM_Case_BAO_CaseType::convertXmlToDefinition($xml);
  98     } else {
  99       $result['values'][$key]['definition'] = array();
 100     }
 101     $result['values'][$key]['is_forkable'] = CRM_Case_BAO_CaseType::isForkable($result['values'][$key]['id']);
 102     $result['values'][$key]['is_forked'] = CRM_Case_BAO_CaseType::isForked($result['values'][$key]['id']);
 103   }
 104   return $result;
 105 }
 106
 107 /**
 108  * Function to delete case type
 109  *
 110  * @param array $params array including id of case_type to delete
 111
 112  * @return array API result array
 113  *
 114  * @access public
 115  *
 116  */
 117 function civicrm_api3_case_type_delete($params) {
 118   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 119 }