CRM/Core/Smarty/plugins/function.crmNavigationMenu.php

   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Output navigation script tag
  38  *
  39  * @param array $params
  40  *   - is_default: bool, true if this is normal/default instance of the menu (which may be subject to CIVICRM_DISABLE_DEFAULT_MENU)
  41  * @param CRM_Core_Smarty $smarty
  42  *   The Smarty object.
  43  *
  44  * @return string
  45  *   HTML
  46  */
  47 function smarty_function_crmNavigationMenu($params, &$smarty) {
  48   $config = CRM_Core_Config::singleton();
  49   //check if logged in user has access CiviCRM permission and build menu
  50   $buildNavigation = !CRM_Core_Config::isUpgradeMode() && CRM_Core_Permission::check('access CiviCRM');
  51   if (defined('CIVICRM_DISABLE_DEFAULT_MENU') && CRM_Utils_Array::value('is_default', $params, FALSE)) {
  52     $buildNavigation = FALSE;
  53   }
  54   if ($config->userFrameworkFrontend) {
  55     $buildNavigation = FALSE;
  56   }
  57   if ($buildNavigation) {
  58     $session = CRM_Core_Session::singleton();
  59     $contactID = $session->get('userID');
  60     if ($contactID) {
  61       // These params force the browser to refresh the js file when switching user, domain, or language
  62       // We don't put them as a query string because some browsers will refuse to cache a page with a ? in the url
  63       // @see CRM_Admin_Page_AJAX::getNavigationMenu
  64       $lang = CRM_Core_I18n::getLocale();
  65       $domain = CRM_Core_Config::domainID();
  66       $key = CRM_Core_BAO_Navigation::getCacheKey($contactID);
  67       $src = CRM_Utils_System::url("civicrm/ajax/menujs/$contactID/$lang/$domain/$key");
  68       // CRM-15493 QFkey needed for quicksearch bar - must be unique on each page refresh so adding it directly to markup
  69       $qfKey = CRM_Core_Key::get('CRM_Contact_Controller_Search', TRUE);
  70       return '<script id="civicrm-navigation-menu" type="text/javascript" src="' . $src . '" data-qfkey=' . json_encode($qfKey) . '></script>';
  71     }
  72   }
  73   return '';
  74 }