3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Navigation BAO.
31 * @package CiviCRM_APIv3
35 * Adjust metadata for navigation reset action.
37 * @param array $params
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'] = array(
44 'all' => 'General Navigation rebuild from xml',
45 'report' => 'Reset report menu to default structure',
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';
55 * @param array $params
56 * Array of name/value pairs.
61 function civicrm_api3_navigation_reset($params) {
62 if ($params['for'] == 'report') {
63 CRM_Core_BAO_Navigation
::rebuildReportsNavigation($params['domain_id']);
65 CRM_Core_BAO_Navigation
::resetNavigation();
66 return civicrm_api3_create_success(1, $params, 'navigation', 'reset');
70 * Adjust metadata for navigation get action.
72 * @param array $params
74 function _civicrm_api3_navigation_get_spec(&$params) {
80 * @param array $params
81 * Array of name/value pairs.
86 function civicrm_api3_navigation_get($params) {
87 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
91 * Adjust metadata for navigation create action.
93 * @param array $params
95 function _civicrm_api3_navigation_create_spec(&$params) {
96 $params['domain_id']['api.default'] = CRM_Core_Config
::domainID();
97 $params['domain_id']['type'] = CRM_Utils_Type
::T_INT
;
98 $params['domain_id']['title'] = 'Domain ID';
102 * Create navigation item.
104 * @param array $params
105 * Array of name/value pairs.
110 function civicrm_api3_navigation_create($params) {
111 civicrm_api3_verify_one_mandatory($params, NULL, array('name', 'label'));
112 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
116 * Adjust metadata for navigation create action.
118 * @param array $params
120 function _civicrm_api3_navigation_delete_spec(&$params) {
124 * Delete navigation item.
126 * @param array $params
127 * Array of name/value pairs.
132 function civicrm_api3_navigation_delete($params) {
133 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);