Menu.php for Custom module build by module builder

mvnrsa · 25 March 2020 11:11

Hi,

When you build a package with module builder the original files are in custom/modulebuilder/packages/ and after the first build a built version sits in custom/modulebuilder/packages/

On SugarCRM it was possible to customise the Menu.php file in the build folder for future builds, but it seems that SuiteCRM overwrites the Menu.php in the build folder every time.

What is the best/correct way to customise Menu.php in a custom module in module builder?

(My current solution is to make Menu.php in the build folder immutable so it can not be overwritten, but that’s an ugly hack and difficult to maintain.)

Tx

pgr · 25 March 2020 11:37

Hi, welcome back - it’s been a long time since we saw you

I am afraid I don’t know much about Module Builder.

Do you know the place in the code where “SuiteCRM overwrites the Menu.php in the build folder every time”? We could try figuring out why that change was introduced, and perhaps create a better solution to whichever problem that was trying to solve…

mvnrsa · 25 March 2020 14:05

Hi,

I’ve tried to find it already, but could not.

Can you suggest any may to customise the menu in a custom module (inside the package)?

pgr · 25 March 2020 16:33

Have a look here, could this be it?

github.com

salesagility/SuiteCRM/blob/master/modules/ModuleBuilder/MB/MBModule.php#L517


        $fp = sugar_fopen($path . '/metadata/studio.php', 'w') ;
        fwrite($fp, $smarty->fetch('modules/ModuleBuilder/tpls/MBModule/Studio.tpl')) ;
        fclose($fp) ;
    } else {
        if (file_exists($path . '/metadata/studio.php')) {
            unlink($path . '/metadata/studio.php') ;
        }
    }
}


public function createMenu($path)
{
    $smarty = new Sugar_Smarty() ;
    $smarty->assign('moduleName', $this->key_name) ;
    $smarty->assign('showvCard', in_array('person', array_keys($this->config[ 'templates' ]))) ;
    $smarty->assign('showimport', $this->config['importable']);
    //write sugar generated class
    $fp = sugar_fopen($path . '/' . 'Menu.php', 'w') ;
    fwrite($fp, $smarty->fetch('modules/ModuleBuilder/tpls/MBModule/Menu.tpl')) ;
    fclose($fp) ;
}

which then uses this file

github.com

salesagility/SuiteCRM/blob/master/modules/ModuleBuilder/tpls/MBModule/Menu.tpl

<?php
/**
 *
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
 *
 * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
 * Copyright (C) 2011 - 2018 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program 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.

This file has been truncated. show original

Note that I am only doing quick searches, I don’t really understand this code, or even what you’re talking about - I really meant it when I said I don’t know much about Module Builder

mvnrsa · 25 March 2020 16:51

Thank you!!

That seems to be it. I will change it not to overwrite an existing file and submit a patch.

pgr · 25 March 2020 16:54

Cool. There was a bit of luck involved here. I’m used to tracking down code to answer “where is this coming from” questions, and sometimes it takes hours.

In this case, I went on a hunch and just searched the code for “createMenu”, and it was the first result

mvnrsa · 25 March 2020 17:12

Thank you!!

I kept searching in the Admin module - duh!

I have made it conditional on the file not existing in my dev instance which solves the issue for me.