Make it possible to create a "all versions" upgrade-file for modules

[madsoliver]

The problem

When working on my modules, and when it is time for a new version, I usually want the new version to run some common tasks. I would as an example allways run $this->registerHook($this->hooks); or $this->updateTableSchema().

The current sollution is to create new files into mymodule/upgrades-directory, naming the file with the new version. In most of my modules all those files are identical, and that bothers me, cause I am lazy 😉

The solution

Making it possible to create ONE file into the same directory called for example mymodule/upgrades/Upgrade-All.php, then ALLWAYS include that file when upgrading the module - then we could add common tasks in that file.
It would not interfere with todays upgrade files.

Tested and working:

    protected static function loadUpgradeVersionList($module_name, $module_version, $registered_version)
    {
        $list = [];

        $upgrade_path = _PS_MODULE_DIR_ . $module_name . '/upgrade/';

        // Check if folder exist and it could be read
        if (file_exists($upgrade_path) && ($files = scandir($upgrade_path, SCANDIR_SORT_NONE))) {
            // Read each file name
            foreach ($files as $file) {
                if (!in_array($file, ['.', '..', '.svn', 'index.php']) && preg_match('/\.php$/', $file)) {
                    $tab = explode('-', $file);

                    if (!isset($tab[1])) {
                        continue;
                    }

                    $file_version = basename($tab[1], '.php');

                    /** PROPOSED CHANGES HERE: 
                    *
                    */
                    // If file_version is string and called "All", we will add that file to the list
                    if ($file_version === 'all' || $file_version === 'All') {
                        $list[] = [
                            'file' => $upgrade_path . $file,
                            'version' => $file_version,
                            'upgrade_function' => [
                                'upgrade_module_all',
                                'upgradeModuleAll', ],
                        ];
                    }

                    // Compare version, if minor than actual, we need to upgrade the module
                    elseif (count($tab) == 2 &&
                         (Tools::version_compare($file_version, $module_version, '<=') &&
                            Tools::version_compare($file_version, $registered_version, '>'))) {
                        $list[] = [
                            'file' => $upgrade_path . $file,
                            'version' => $file_version,
                            'upgrade_function' => [
                                'upgrade_module_' . str_replace('.', '_', $file_version),
                                'upgradeModule' . str_replace('.', '', $file_version), ],
                        ];
                    }
                }
            }
        }

Alternatives

I tried using the hook actionBeforeUpgradeModule, but that does not work since, cause right before the hook is called, this is executed: $this->hookManager->disableHooksForModule($this->moduleDataProvider->getModuleIdByName($name));

Additional context

No response

Do you plan to work on this subject?

• I'm willing to contribute a formal specification.
• I'm willing to provide any wireframes or design assets required for this feature.
• I'm willing to submit a Pull Request that implements this feature.
• I'm willing to help verify that the implemented feature works as intended and produces no unintended side effects.