drupal-civicrm/sites/all/modules/civicrm/api/v3/Navigation.php

135 lines
4.2 KiB
PHP
Raw Normal View History

2018-01-14 15:10:16 +02:00
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* This api exposes CiviCRM Navigation BAO.
*
* @package CiviCRM_APIv3
*/
/**
* Adjust metadata for navigation reset action.
*
* @param array $params
*/
function _civicrm_api3_navigation_reset_spec(&$params) {
$params['for']['api.required'] = TRUE;
$params['for']['title'] = "Is this reset for all navigation or reports";
$params['for']['type'] = CRM_Utils_Type::T_STRING;
$params['for']['options'] = array(
'all' => 'General Navigation rebuild from xml',
'report' => 'Reset report menu to default structure',
);
$params['domain_id']['api.default'] = CRM_Core_Config::domainID();
$params['domain_id']['type'] = CRM_Utils_Type::T_INT;
$params['domain_id']['title'] = 'Domain ID';
}
/**
* Reset navigation.
*
* @param array $params
* Array of name/value pairs.
*
* @return array
* API result array.
*/
function civicrm_api3_navigation_reset($params) {
if ($params['for'] == 'report') {
CRM_Core_BAO_Navigation::rebuildReportsNavigation($params['domain_id']);
}
CRM_Core_BAO_Navigation::resetNavigation();
return civicrm_api3_create_success(1, $params, 'navigation', 'reset');
}
/**
* Adjust metadata for navigation get action.
*
* @param array $params
*/
function _civicrm_api3_navigation_get_spec(&$params) {
}
/**
* Reset navigation.
*
* @param array $params
* Array of name/value pairs.
*
* @return array
* API result array.
*/
function civicrm_api3_navigation_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Adjust metadata for navigation create action.
*
* @param array $params
*/
function _civicrm_api3_navigation_create_spec(&$params) {
$params['domain_id']['api.default'] = CRM_Core_Config::domainID();
$params['domain_id']['type'] = CRM_Utils_Type::T_INT;
$params['domain_id']['title'] = 'Domain ID';
}
/**
* Create navigation item.
*
* @param array $params
* Array of name/value pairs.
*
* @return array
* API result array.
*/
function civicrm_api3_navigation_create($params) {
civicrm_api3_verify_one_mandatory($params, NULL, array('name', 'label'));
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Adjust metadata for navigation create action.
*
* @param array $params
*/
function _civicrm_api3_navigation_delete_spec(&$params) {
}
/**
* Delete navigation item.
*
* @param array $params
* Array of name/value pairs.
*
* @return array
* API result array.
*/
function civicrm_api3_navigation_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}