| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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']) |
| 55 | && !CRM_Case_BAO_CaseType::isForked($params['id']) // which is not yet forked |
| 56 | && !CRM_Case_BAO_CaseType::isForkable($params['id']) // for which new forks are prohibited |
| 57 | ) { |
| 58 | unset($params['definition']); |
| 59 | } |
| 60 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'CaseType'); |
| 61 | return _civicrm_api3_case_type_get_formatResult($result); |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Retrieve case types. |
| 66 | * |
| 67 | * @param array $params |
| 68 | * |
| 69 | * @return array |
| 70 | * case types keyed by id |
| 71 | */ |
| 72 | function civicrm_api3_case_type_get($params) { |
| 73 | if (!empty($params['options']) && !empty($params['options']['is_count'])) { |
| 74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 75 | } |
| 76 | $caseTypes = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 77 | // format case type, to fetch xml definition |
| 78 | return _civicrm_api3_case_type_get_formatResult($caseTypes); |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Format definition. |
| 83 | * |
| 84 | * @param array $result |
| 85 | * |
| 86 | * @return array |
| 87 | * @throws \CRM_Core_Exception |
| 88 | */ |
| 89 | function _civicrm_api3_case_type_get_formatResult(&$result) { |
| 90 | foreach ($result['values'] as $key => $caseType) { |
| 91 | $caseTypeName = (isset($caseType['name'])) ? $caseType['name'] : CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseType['id'], 'name', 'id', TRUE); |
| 92 | $xml = CRM_Case_XMLRepository::singleton()->retrieve($caseTypeName); |
| 93 | if ($xml) { |
| 94 | $result['values'][$key]['definition'] = CRM_Case_BAO_CaseType::convertXmlToDefinition($xml); |
| 95 | } |
| 96 | else { |
| 97 | $result['values'][$key]['definition'] = array(); |
| 98 | } |
| 99 | $result['values'][$key]['is_forkable'] = CRM_Case_BAO_CaseType::isForkable($result['values'][$key]['id']); |
| 100 | $result['values'][$key]['is_forked'] = CRM_Case_BAO_CaseType::isForked($result['values'][$key]['id']); |
| 101 | } |
| 102 | return $result; |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * Function to delete case type. |
| 107 | * |
| 108 | * @param array $params |
| 109 | * Array including id of CaseType to delete. |
| 110 | * |
| 111 | * @return array |
| 112 | * API result array |
| 113 | */ |
| 114 | function civicrm_api3_case_type_delete($params) { |
| 115 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 116 | } |