Sugar Developer Guide Version 5.1

Shortcuts

It is possible to override or create new Shortcuts menu items.

Master Directories

Files in these directories can be edited and new files can be added to these directories.

•	/custom/Extension/application/Ext/Menus/

•	/custom/Extension/modules/<MODULE_NAME>/Ext/Menus/

Production Directories

Files in these directories are auto-generated by the system.

•	/custom/application/Ext/Menus/menu.ext.php

•	/custom/modules/<MODULE_NAME>/Ext/Menus/menu.ext.php

Description

Shortcut menu files either replace entirely or add to the menu items available in the menus on the left-hand side of the user interface. In the Master Directories you can have many files like:

•	/custom/Extension/modules/Calls/Ext/Menus/New_menu_items.php

•	/custom/Extension/modules/Calls/Ext/Menus/Custom_Menus.php

•	/custom/Extension/modules/Calls/Ext/Menus/Menu_items.php

During the repair function (Admin->Repair->Quick Repair and Rebuild), all of these files will be merged together into the production directory and they become the file:

/custom/modules/Leads/ext/Menus/menu.ext.php

For example, a menu extension file for the Calls module could contain the following:

<?php

if(ACLController::checkAccess('Calls', 'import', true)) {

$module_menu[]=Array("index.php?module=Calls&action=MakeIndex",$mod_strings['LNK_INDEX_CALLS'], "Import");

}

?>

 

This would add a menu item to the Calls modules Shortcuts menu. The $module_menu array takes three elements.

•	The first is the URL that the menu item will run.

•	The second is the text that will be shown on the menu, in this case we added some custom language text in a separate custom language file that we will go over later in this document.

•

The last is the name of the icon associated with this menu option. This word will have “.gif” added to the end of it. If you want to use a PNG file here you would rename import.png to import.gif and load it into the themes/default/images directory. Even though it is named with the 'gif' extension it will still work.

If you added a $module_menu=array(); to the top of this file, you would effectively clear out any of the standard menu items. Then you could then replace them all with new definitions.

If the custom file is in the /custom/Extension/application/Ext/Menus/ directory then your menu changes will affect all shortcut menus in every module.