| 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 Navigation BAO. |
| 30 | * |
| 31 | * @package CiviCRM_APIv3 |
| 32 | */ |
| 33 | |
| 34 | /** |
| 35 | * Adjust metadata for navigation reset action. |
| 36 | * |
| 37 | * @param array $params |
| 38 | */ |
| 39 | function _civicrm_api3_navigation_reset_spec(&$params) { |
| 40 | $params['for']['api.required'] = TRUE; |
| 41 | $params['for']['title'] = "Is this reset for all navigation or reports"; |
| 42 | $params['for']['type'] = CRM_Utils_Type::T_STRING; |
| 43 | $params['for']['options'] = [ |
| 44 | 'all' => 'General Navigation rebuild from xml', |
| 45 | 'report' => 'Reset report menu to default structure', |
| 46 | ]; |
| 47 | $params['domain_id']['api.default'] = CRM_Core_Config::domainID(); |
| 48 | $params['domain_id']['type'] = CRM_Utils_Type::T_INT; |
| 49 | $params['domain_id']['title'] = 'Domain ID'; |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Reset navigation. |
| 54 | * |
| 55 | * @param array $params |
| 56 | * Array of name/value pairs. |
| 57 | * |
| 58 | * @return array |
| 59 | * API result array. |
| 60 | */ |
| 61 | function civicrm_api3_navigation_reset($params) { |
| 62 | if ($params['for'] == 'report') { |
| 63 | CRM_Core_BAO_Navigation::rebuildReportsNavigation($params['domain_id']); |
| 64 | } |
| 65 | CRM_Core_BAO_Navigation::resetNavigation(); |
| 66 | return civicrm_api3_create_success(1, $params, 'navigation', 'reset'); |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Adjust metadata for navigation get action. |
| 71 | * |
| 72 | * @param array $params |
| 73 | */ |
| 74 | function _civicrm_api3_navigation_get_spec(&$params) { |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Reset navigation. |
| 79 | * |
| 80 | * @param array $params |
| 81 | * Array of name/value pairs. |
| 82 | * |
| 83 | * @return array |
| 84 | * API result array. |
| 85 | */ |
| 86 | function civicrm_api3_navigation_get($params) { |
| 87 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Create navigation item. |
| 92 | * |
| 93 | * @param array $params |
| 94 | * Array of name/value pairs. |
| 95 | * |
| 96 | * @return array |
| 97 | * API result array. |
| 98 | */ |
| 99 | function civicrm_api3_navigation_create($params) { |
| 100 | civicrm_api3_verify_one_mandatory($params, NULL, ['name', 'label']); |
| 101 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Navigation'); |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Adjust metadata for navigation create action. |
| 106 | * |
| 107 | * @param array $params |
| 108 | */ |
| 109 | function _civicrm_api3_navigation_delete_spec(&$params) { |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * Delete navigation item. |
| 114 | * |
| 115 | * @param array $params |
| 116 | * Array of name/value pairs. |
| 117 | * |
| 118 | * @return array |
| 119 | * API result array. |
| 120 | */ |
| 121 | function civicrm_api3_navigation_delete($params) { |
| 122 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 123 | } |