api/v3/CaseType.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * This api exposes CiviCRM Case.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create or update case type.
  36  *
  37  * @param array $params
  38  *   Input parameters.
  39  *
  40  * @throws API_Exception
  41  * @return array
  42  *   API result array
  43  */
  44 function civicrm_api3_case_type_create($params) {
  45   civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__));
  46   // Computed properties.
  47   unset($params['is_forkable']);
  48   unset($params['is_forked']);
  49
  50   if (!array_key_exists('is_active', $params) && empty($params['id'])) {
  51     $params['is_active'] = TRUE;
  52   }
  53   // This is an existing case-type.
  54   if (!empty($params['id']) && isset($params['definition'])
  55     // which is not yet forked
  56     && !CRM_Case_BAO_CaseType::isForked($params['id'])
  57     // for which new forks are prohibited
  58     && !CRM_Case_BAO_CaseType::isForkable($params['id'])
  59   ) {
  60     unset($params['definition']);
  61   }
  62   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'CaseType');
  63   return _civicrm_api3_case_type_get_formatResult($result);
  64 }
  65
  66 /**
  67  * Retrieve case types.
  68  *
  69  * @param array $params
  70  *
  71  * @return array
  72  *   case types keyed by id
  73  */
  74 function civicrm_api3_case_type_get($params) {
  75   if (!empty($params['options']) && !empty($params['options']['is_count'])) {
  76     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77   }
  78   $caseTypes = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  79   // format case type, to fetch xml definition
  80   $options = _civicrm_api3_get_options_from_params($params);
  81   return _civicrm_api3_case_type_get_formatResult($caseTypes, $options);
  82 }
  83
  84 /**
  85  * Format definition.
  86  *
  87  * @param array $result
  88  * @param array $options
  89  *
  90  * @return array
  91  * @throws \CRM_Core_Exception
  92  */
  93 function _civicrm_api3_case_type_get_formatResult(&$result, $options = []) {
  94   foreach ($result['values'] as $key => &$caseType) {
  95     if (!empty($caseType['definition'])) {
  96       list($xml) = CRM_Utils_XML::parseString($caseType['definition']);
  97       $caseType['definition'] = $xml ? CRM_Case_BAO_CaseType::convertXmlToDefinition($xml) : [];
  98     }
  99     else {
 100       if (empty($options['return']) || !empty($options['return']['definition'])) {
 101         $caseTypeName = (isset($caseType['name'])) ? $caseType['name'] : CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseType['id'], 'name', 'id', TRUE);
 102         $xml = CRM_Case_XMLRepository::singleton()->retrieve($caseTypeName);
 103         $caseType['definition'] = $xml ? CRM_Case_BAO_CaseType::convertXmlToDefinition($xml) : [];
 104       }
 105     }
 106     $caseType['is_forkable'] = CRM_Case_BAO_CaseType::isForkable($caseType['id']);
 107     $caseType['is_forked'] = CRM_Case_BAO_CaseType::isForked($caseType['id']);
 108   }
 109   return $result;
 110 }
 111
 112 /**
 113  * Function to delete case type.
 114  *
 115  * @param array $params
 116  *   Array including id of CaseType to delete.
 117  *
 118  * @return array
 119  *   API result array
 120  */
 121 function civicrm_api3_case_type_delete($params) {
 122   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 123 }