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