api/v3/Navigation.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM Navigation BAO.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Adjust metadata for navigation reset action.
  20  *
  21  * @param array $params
  22  */
  23 function _civicrm_api3_navigation_reset_spec(&$params) {
  24   $params['for']['api.required'] = TRUE;
  25   $params['for']['title'] = "Is this reset for all navigation or reports";
  26   $params['for']['type'] = CRM_Utils_Type::T_STRING;
  27   $params['for']['options'] = [
  28     'all' => 'General Navigation rebuild from xml',
  29     'report' => 'Reset report menu to default structure',
  30   ];
  31   $params['domain_id']['api.default'] = CRM_Core_Config::domainID();
  32   $params['domain_id']['type'] = CRM_Utils_Type::T_INT;
  33   $params['domain_id']['title'] = 'Domain ID';
  34 }
  35
  36 /**
  37  * Reset navigation.
  38  *
  39  * @param array $params
  40  *   Array of name/value pairs.
  41  *
  42  * @return array
  43  *   API result array.
  44  */
  45 function civicrm_api3_navigation_reset($params) {
  46   if ($params['for'] == 'report') {
  47     CRM_Core_BAO_Navigation::rebuildReportsNavigation($params['domain_id']);
  48   }
  49   CRM_Core_BAO_Navigation::resetNavigation();
  50   return civicrm_api3_create_success(1, $params, 'navigation', 'reset');
  51 }
  52
  53 /**
  54  * Adjust metadata for navigation get action.
  55  *
  56  * @param array $params
  57  */
  58 function _civicrm_api3_navigation_get_spec(&$params) {
  59 }
  60
  61 /**
  62  * Reset navigation.
  63  *
  64  * @param array $params
  65  *   Array of name/value pairs.
  66  *
  67  * @return array
  68  *   API result array.
  69  */
  70 function civicrm_api3_navigation_get($params) {
  71   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  72 }
  73
  74 /**
  75  * Create navigation item.
  76  *
  77  * @param array $params
  78  *   Array of name/value pairs.
  79  *
  80  * @return array
  81  *   API result array.
  82  */
  83 function civicrm_api3_navigation_create($params) {
  84   civicrm_api3_verify_one_mandatory($params, NULL, ['name', 'label']);
  85   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Navigation');
  86 }
  87
  88 /**
  89  * Adjust metadata for navigation create action.
  90  *
  91  * @param array $params
  92  */
  93 function _civicrm_api3_navigation_delete_spec(&$params) {
  94 }
  95
  96 /**
  97  * Delete navigation item.
  98  *
  99  * @param array $params
 100  *   Array of name/value pairs.
 101  *
 102  * @return array
 103  *   API result array.
 104  */
 105 function civicrm_api3_navigation_delete($params) {
 106   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 107 }